A Vim wrapper for running tests on different granularities.

Currently the following testing frameworks are supported:

Since Gary Bernhardt invented testing from Vim, there have been multiple plugins implementing this functionality (rspec.vim, vroom.vim etc). However, all of these solutions have bad designs, unclear ideas and aren't extendable. So I decided to create test.vim, featuring:

• zero dependencies
• zero configuration required (it Does the Right Thing™, see Philosophy)
• inteface for adding new testing frameworks
• automatic detection of correct test runner
• polyfill for nearest tests (by constructing regexes)
• built-in integration with Dispatch/Vimux/Tslime
• fully customized CLI options configuration

Internally test.vim consists of a thoughtfully designed core, and testing frameworks are simply plugged in, so that they all work in the same unified way.

Ruby users, you get all of the features of rspec.vim + vroom.vim, but without any of the tedious configuration (test.vim knows how you want to run your test command).

Plug[in] 'janko-m/vim-test'

Add your preferred mappings to your .vimrc file:

nmap <silent> <leader>t :TestNearest<CR>
nmap <silent> <leader>T :TestFile<CR>
nmap <silent> <leader>a :TestSuite<CR>
nmap <silent> <leader>l :TestLast<CR>
nmap <silent> <leader>g :TestVisit<CR>

You can instruct test.vim to run your tests with different strategies (with synchronous or asynchronous execution). To use a specific strategy, assign it like this:

" make test commands execute using dispatch.vim
let test#strategy = "dispatch"

You can execute Test.vim commands directly, and pass them CLI options:

:TestNearest --verbose
:TestFile --format documentation
:TestSuite --fail-fast

If you want some options to stick around, see Configuring.

Aside from the main commands, you get a corresponding Vim command for each test runner (which also accept options):

:RSpec --tag ~slow
:Mocha --grep 'API'
:ExUnit --trace
:Nose --failed

I found these commands to be really useful when using multiple testing frameworks in the same project.

If you want some CLI options to stick around, you can configure them in your .vimrc:

let test#ruby#minitest#options = '--verbose'

You can also choose a more granular approach:

let test#ruby#rspec#options = {
  \ 'nearest': '--backtrace',
  \ 'file':    '--format documentation',
  \ 'suite':   '--tag ~slow',
\}

You can instruct test.vim to use a custom executable for a test runner.

let test#ruby#rspec#executable = 'foreman run rspec'

Test.vim has file pattern it uses to determine whether a file belongs to certain testing framework. You can override that pattern by overriding the file_pattern variable:

let test#ruby#minitest#file_pattern = '_spec\.rb' " the default is '_test\.rb'

Since there are multiple Python test runners for the same type of tests, test.vim has no way of detecting which one did you intend to use. By default the first available will be chosen, but you can force a specific one:

let test#python#runner = 'pytest'
" or
let test#python#runner = 'nose'

See CONTRIBUTING.md for information on extending test.vim.

This plugin was strongly influenced by Gary Bernhardt's Destroy All Software. I also want to thank rspec.vim, from which I borrowed GUI support for OS X, and Windows support. And also thanks to vroom.vim.

Copyright © Janko Marohnić. Distributed under the same terms as Vim itself. See :help license.