https://github.com/calvinchengx/vim-test

Run your tests at the speed of thought
https://github.com/calvinchengx/vim-test

Last synced: 4 months ago
JSON representation

Run your tests at the speed of thought

Host: GitHub
URL: https://github.com/calvinchengx/vim-test
Owner: calvinchengx
Fork: true (vim-test/vim-test)
Created: 2015-04-04T15:50:28.000Z (about 10 years ago)
Default Branch: master
Last Pushed: 2015-03-30T13:10:06.000Z (about 10 years ago)
Last Synced: 2024-10-02T09:14:40.814Z (8 months ago)
Language: VimL
Homepage:
Size: 1.41 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# test.vim

A Vim wrapper for running tests on different granularities.

![usage overview](/screenshots/granularity.gif)

Currently the following testing frameworks are supported:

| Language | Frameworks |
| :------------: | ------------------------------------- |
| **Ruby** | RSpec, [Minitest][minitest], Cucumber |
| **JavaScript** | Mocha, Jasmine |
| **Python** | Nose, PyTest |
| **Elixir** | ExUnit |
| **Go** | Go |
| **Clojure** | Fireplace.vim |
| **Shell** | Bats |
| **VimScript** | VSpec, Vader.vim |
| **Lua** | Busted |

## Introduction

Since Gary Bernhardt invented testing from Vim, there have been multiple
plugins implementing this functionality. However, I found none of the current
solutions to be good enough. Thus test.vim was born, featuring:

* zero dependencies
* zero configuration required (it Does the Right Thing™, see [**Philosophy**](https://github.com/janko-m/vim-test/wiki))
* abstraction for testing frameworks (and easily extendable)
* automatic detection of correct test runner
* **polyfill** for nearest tests (by [constructing regexes](#commands))
* built-in integration with Dispatch/Vimux/Tslime
* fully customized CLI options configuration

## Setup

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

Add your preferred mappings to your `.vimrc` file:

```vim
nmap t :TestNearest
nmap T :TestFile
nmap a :TestSuite
nmap l :TestLast
nmap g :TestVisit
```

| Command | Description |
| :------- | :----------- |
| `:TestNearest` | In a test file runs the test nearest to the cursor, otherwise runs the last nearest test. In test frameworks that don't support line numbers it will **polyfill** this functionality with [regexes](#commands). |
| `:TestFile` | In a test file runs all tests in the current file, otherwise runs the last file tests. |
| `:TestSuite` | Runs the whole test suite (if the current file is a test file, runs that framework's test suite, otherwise determines the test framework from the last run test). |
| `:TestLast` | Runs the last test. |
| `:TestVisit` | Visits the test file from which you last run your tests (useful when you're trying to make a test pass, and you dive deep into application code and close your test buffer to make more space, and once you've made it pass you want to go back to the test file to write more tests). |

## Strategies

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:

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

## Commands

![nearest polyfill](/screenshots/nearest.gif)

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](#configuring).

### Runner commands

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.

## Configuring

### CLI options

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

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

You can also choose a more granular approach:

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

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

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

### Language-specific

#### Python

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:

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

## Extending

If you wish to extend this plugin with your own test runners, first of all,
if the runner is well-known, I would encourage to help me merge it into
test.vim.

That being said, if you want to do this for yourself, you need to do 2 things.
First, add your runner to the list in your `.vimrc`:

```vim
" First letter of runner's name must be uppercase
let test#runners = {'MyLanguage': ['MyRunner']}
```

Second, create `~/.vim/autoload/test/mylanguage/myrunner.vim`, and define the following
methods:

```vim
" Returns true if the given file belongs to your test runner
function! test#mylanguage#myrunner#test_file(file)

" Returns test runner's arguments which will run the current file and/or line
function! test#mylanguage#myrunner#build_position(type, position)

" Returns processed args (if you need to do any processing)
function! test#mylanguage#myrunner#build_args(args)

" Returns the executable of your test runner
function! test#mylanguage#myrunner#executable()
```

See [`autoload/test`](/autoload/test) for examples.

## Credits

This plugin was strongly influenced by Gary Bernhardt's Destroy All Software.
I also want to thank [rspec.vim](https://github.com/thoughtbot/vim-rspec), from
which I borrowed GUI support for OS X, and Windows support. And also thanks to
[vroom.vim](https://github.com/skalnik/vim-vroom).

## License

[minitest]: https://github.com/janko-m/vim-test/wiki/Minitest

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/calvinchengx/vim-test

Awesome Lists containing this project

README