Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marilari88/neotest-vitest
Vitest adapter for Neovim Neotest plugin
https://github.com/marilari88/neotest-vitest
lua neotest nvim vitest
Last synced: 1 day ago
JSON representation
Vitest adapter for Neovim Neotest plugin
- Host: GitHub
- URL: https://github.com/marilari88/neotest-vitest
- Owner: marilari88
- Created: 2022-08-20T15:30:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-19T23:18:47.000Z (about 1 month ago)
- Last Synced: 2025-01-19T21:11:57.674Z (8 days ago)
- Topics: lua, neotest, nvim, vitest
- Language: Lua
- Homepage:
- Size: 172 KB
- Stars: 117
- Watchers: 2
- Forks: 37
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# neotest-vitest
This plugin provides a [Vitest](https://vitest.dev/) adapter for the [Neotest](https://github.com/rcarriga/neotest) framework.
Credits to [neotest-jest](https://github.com/haydenmeade/neotest-jest)
## Known issues
- test.each is currently not well supported (WIP)
## How to install it
### Lazy.nvim
```lua
{
"nvim-neotest/neotest",
dependencies = {
...,
"marilari88/neotest-vitest",
},
config = function()
require("neotest").setup({
...,
adapters = {
require("neotest-vitest"),
}
})
end,
}
```
### LazyVim
```lua
{
"nvim-neotest/neotest",
dependencies = {
"marilari88/neotest-vitest",
},
opts = {
adapters = {
["neotest-vitest"] = {},
},
},
}
```
### Packer
```lua
use({
"nvim-neotest/neotest",
requires = {
...,
"marilari88/neotest-vitest",
}
config = function()
require("neotest").setup({
...,
adapters = {
require("neotest-vitest")
}
})
end
})
```
Make sure you have Treesitter installed with the right language parser installed
```
:TSInstall javascript
```
## Configuration
```lua
{
"nvim-neotest/neotest",
dependencies = {
...,
"marilari88/neotest-vitest",
},
config = function()
require("neotest").setup({
...,
adapters = {
require("neotest-vitest") {
-- Filter directories when searching for test files. Useful in large projects (see Filter directories notes).
filter_dir = function(name, rel_path, root)
return name ~= "node_modules"
end,
},
}
})
end,
}
```
### Stricter file parsing to determine test files
Use `is_test_file` option to add a custom criteria for test file discovery.
```lua
---Custom criteria for a file path to determine if it is a vitest test file.
---@async
---@param file_path string Path of the potential vitest test file
---@return boolean
is_test_file = function(file_path)
-- Check if the project is "my-peculiar-project"
if string.match(file_path, "my-peculiar-project") then
-- Check if the file path includes something else
if string.match(file_path, "/myapp/") then
-- eg. only files in __tests__ are to be considered
return string.match(file_path, "__tests__")
end
end
return false
end,
```
### Filter directories
Use `filter_dir` option to limit directories to be searched for tests.
```lua
---Filter directories when searching for test files
---@async
---@param name string Name of directory
---@param rel_path string Path to directory, relative to root
---@param root string Root directory of project
---@return boolean
filter_dir = function(name, rel_path, root)
local full_path = root .. "/" .. rel_path
if root:match("projects/my-large-monorepo") then
if full_path:match("^unit_tests") then
return true
else
return false
end
else
return name ~= "node_modules"
end
end
```
### Watch mode mappings
```lua
vim.api.nvim_set_keymap(
"n",
"twr",
"lua require('neotest').run.run({ vitestCommand = 'vitest --watch' })",
{desc = "Run Watch"}
)
vim.api.nvim_set_keymap(
"n",
"twf",
"lua require('neotest').run.run({ vim.fn.expand('%'), vitestCommand = 'vitest --watch' })",
{desc = "Run Watch File"}
)
```
## Usage
See neotest's documentation for more information on how to run tests.
## :gift: Contributing
Please raise a PR if you are interested in adding new functionality or fixing any bugs. When submitting a bug, please include an example spec that can be tested.
To trigger the tests for the adapter, run:
```sh
./scripts/test
```
## Bug Reports
Please file any bug reports and I _might_ take a look if time permits otherwise please submit a PR, this plugin is intended to be by the community for the community.