https://github.com/heavenshell/vim-quickrun-hook-unittest
Quickrun hook for enable to unittest by selecting method.
https://github.com/heavenshell/vim-quickrun-hook-unittest
Last synced: 6 months ago
JSON representation
Quickrun hook for enable to unittest by selecting method.
- Host: GitHub
- URL: https://github.com/heavenshell/vim-quickrun-hook-unittest
- Owner: heavenshell
- Created: 2012-06-16T08:37:14.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2023-10-30T01:40:35.000Z (over 2 years ago)
- Last Synced: 2025-03-06T02:12:12.534Z (over 1 year ago)
- Language: Vim Script
- Homepage:
- Size: 10.7 MB
- Stars: 20
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quickrun hook for unittest
QuickRun hook for enable to unittest by selecting method.
For example.
```python
from unittest import TestCase
class TestFoo(TestCase):
def test_foo(self):
pass
def test_bar(TestCase):
pass
```
QuickRun execute all tests.
But if you want to run only `test_bar()` method.
## Example
### Python
### Jest
## Install
Install the distributed files into Vim runtime directory which is usually
~/.vim/, or $HOME/vimfiles on Windows.
If you install pathogen provided by Tim Pope, you should extract the
file into 'bundle' directory.
## Usage
1. Add below example to your `.vimrc` or `_vimrc`.
```vim
nnoremap ,r :QuickRun -mode n -runner job -hook/unittest/enable 1
```
2. Open your unittest file.
3. Move cursor to test method scope.
4. For example, move cursor next to def test_foo(self) line.
5. Type `,r` and then execute QuickRun automatically.
6. QuickRun output only test_foo() test result.
## Test runners
This plugin required awesome testing framework/runner to run.
- Python
- [nose(Python unittesting framework)](http://nose.readthedocs.org/en/latest/)
- [py.test(Python unittesting framework)](http://pytest.org/latest/index.html)
- [Django](https://docs.djangoproject.com/en/dev/topics/testing/overview/#running-tests)
- PHP
- [Stagehand_TestRunner:PHP continuous test runner](http://piece-framework.com/projects/stagehand-testrunner/wiki)
- Ruby
- [RSpec: Ruby testing tool for Behaviour-Driven Development](http://rspec.info/)
- [minitest/unit: a small and incredibly fast unit testing framework](https://github.com/seattlerb/minitest)
- JavaScript / TypeScript
- [Mocha - the fun, simple, flexible JavaScript test framework](https://mochajs.org)
- [Jest - Delightful JavaScript Testing](http://facebook.github.io/jest/)
- [vitest - Next generation testing framework powered by Vite](https://vitest.dev/)
- [Deno](https://deno.land/manual/testing)
- Rust(`cargo test`)
- [Rust - Rust Programming Language](https://doc.rust-lang.org/stable/rust-by-example/testing.html)
## Example Quickrun configs(recommend)
```vim
let g:quickrun_unittest_config = {
\ 'typescript': {
\ '.spec.ts\%[x]': { " *.spec.ts or *.spec.tsx run jest
\ 'ft': 'typescript.jest',
\ 'config': {'command': 'jest'},
\ },
\ 'test.ts\%[x]': { " *_test.ts or *_test.tsx run Deno's test
\ 'ft': 'typescript.deno',
\ 'config': {'command': 'deno'},
\ },
\ '.spec.js': { " *.spec.js run mocha
\ 'ft': 'typescript.mocha',
\ 'config': {'command': 'mocha'},
\ },
\ },
\ 'python': {
\ 'test_[A-z0-9_.]*.py': {
\ 'ft': 'python.unit',
\ 'config': {'command': 'nosetests', 'cmdopt': '-v -s -d'},
\ },
\ 'tests.py': {
\ 'ft': 'python.unit',
\ 'config': {'command': 'nosetests', 'cmdopt': '-v -s -d'},
\ },
\ },
\ 'php': {
\ 'test.php': {
\ 'ft': 'php.unit',
\ 'config': {'command': 'testrunner', 'cmdopt': 'phpunit'},
\ },
\ },
\ 'perl': {
\ '.t': {
\ 'ft': 'perl.unit',
\ 'config': {'command': 'prove'},
\ },
\ },
\ 'ruby': {
\ '_spec.rb': {
\ 'ft': 'ruby.rspec',
\ 'config': {'command': 'rspec', 'cmdopt': '-f d'},
\ },
\ },
\ 'go': {
\ '_test.go': {
\ 'ft': 'go.test',
\ 'config': {'command': 'go', 'cmdopt': 'test -v', 'exec': ['%c %o %a'] },
\ },
\ }}
" You can describe like followings
let config = {
\ 'ft': 'python.django',
\ 'config': {
\ 'command': 'python',
\ 'cmdopt': 'test -v 2 --keepdb',
\ 'root': 1,
\ 'test_fw': 'unittest',
\ }}
let g:quickrun_unittest_config['python'] = {
\ 'test_[A-z0-9_.]*.py': config,
\ 'tests.py': config,
\ }
```
- Key of g:quickrun_unittest_config is filetype
- Key of filetype is file name pattern
- Value of ft is Quickrun unittest's file name
- Value of config is Quickrun's command
## Example QuickRun configs(multiple filetypes)
```vim
augroup QuickRunUnitTest
autocmd!
autocmd BufWinEnter,BufNewFile *test.php setlocal filetype=php.unit
" Choose UnitTest, py.test or Django.
autocmd BufWinEnter,BufNewFile test_*.py setlocal filetype=python.unit
" autocmd BufWinEnter,BufNewFile test_*.py setlocal filetype=python.pytest
" autocmd BufWinEnter,BufNewFile test_*.py setlocal filetype=python.django
autocmd BufWinEnter,BufNewFile *.t setlocal filetype=perl.unit
autocmd BufWinEnter,BufNewFile *_spec.rb setlocal filetype=ruby.rspec
autocmd BufWinEnter,BufNewFile *_test.rb setlocal filetype=ruby.minitest
autocmd BufWinEnter,BufNewFile *_test.go setlocal filetype=go.test
" TypeScript support only Jest
autocmd BufWinEnter,BufNewFile *.spec.ts setlocal filetype=typescript.jest
" Choose Mocha or Jest
" autocmd BufWinEnter,BufNewFile *.test.js setlocal filetype=javascript.mocha
" autocmd BufWinEnter,BufNewFile *.test.js setlocal filetype=javascript.jest
autocmd BufWinEnter,BufNewFile *test.ts setlocal filetype=typescript.deno
autocmd BufWinEnter,BufNewFile *test.tsx setlocal filetype=typescript.deno
augroup END
let g:quickrun_config = {}
let g:quickrun_config['php.unit'] = { 'command': 'testrunner', 'cmdopt': 'phpunit' }
let g:quickrun_config['python.unit'] = { 'command': 'nosetests', 'cmdopt': '-v -s' }
let g:quickrun_config['python.pytest'] = { 'command': 'py.test', 'cmdopt': '-v' }
" Django unittest
let g:quickrun_config['python.django'] = { 'command': 'python', 'cmdopt': 'test --pararell=2 --keepdb -v2'}
" pytest-django
" let g:quickrun_config['python.django'] = { 'command': 'python', 'cmdopt': 'test --noinput -- --verbose --reuse-db', 'test_fw': 'pytest' }
let g:quickrun_config['ruby.rspec'] = { 'command': 'rspec', 'cmdopt': '-f d' }
let g:quickrun_config['ruby.minitest'] = { 'command': 'ruby' }
let g:quickrun_config['go.test'] = { 'command': 'go', 'cmdopt': 'test -v' }
let g:quickrun_config['typescript.jest'] = { 'command': 'jest' }
let g:quickrun_config['javascript.mocha'] = { 'command': 'mocha' }
let g:quickrun_config['javascript.jest'] = { 'command': 'jest' }
```
### Extra config
If you using jest in monorepo(lerna) and enable autochdir, you can set jest.config.
```vim
let g:quickrun_hook_unittest_enable_jest_config = 1
" If you don't set below path, default jest.config.json was used.
let g:quickrun_hook_unittest_jest_config_path = '/path/to/jest.config.json
```
Since Jest v27, default testEnvironment was changed from `jsdom` to `node`.
QuickRunUnitTest keep backward compatible with previous behaviour as `jsdom`.
If you want change to node, you can set like following.
```vim
let g:quickrun_hook_unittest_jest_test_environment = 'node'
```
This option is affect only jest in monorepo(lerna) and enable autochdir.
## LICENSE
zlib License(Same as vim-quickrun)