Thank you for your interest in contributing to vim-test! This document provides guidelines and information for contributors.

Use conventional commits.

When adding support for a new test runner, follow these steps:

Create a new file at autoload/test/[language]/[runner].vim with the following required functions:

" Returns true if the given file belongs to your test runner
function! test#[language]#[runner]#test_file(file)

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

" Returns processed args (if you need to do any processing)
function! test#[language]#[runner]#build_args(args)

" Returns the executable of your test runner
function! test#[language]#[runner]#executable()

Any logic that is common to runners for that language should be added to autoload/test/[language].vim.

Create appropriate test fixtures in spec/fixtures/[runner]/ that demonstrate the test runner's file patterns and structure.

Create a spec file at spec/[runner]_spec.vim to test your runner implementation.

• Add your test runner to the README.md table with language, runner name, and identifier
• Update doc/test.txt with relevant documentation

• Install dependencies: gem install vim-flavor
• Run all tests: vim-flavor test spec/
• Run specific test file: vim-flavor test spec/[filename]_spec.vim
• Test fixtures in spec/fixtures/ provide examples for each supported test runner

By contributing to vim-test, you agree that your contributions will be licensed under the MIT License.