nix/12.nixvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 7

CONTRIBUTING: explain common test attrset names

Browse source
This commit is contained in:
Austin Horstman 2026-04-21 20:42:19 -05:00
parent 27414212a2
commit 53aad7a9aa
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTING.md
View file

@ -300,6 +300,13 @@ The tests are located in the [tests/test-sources](tests/test-sources) directory,
Tests can either be a simple attribute set, or a function taking `{pkgs}` as an input. The keys of the set are configuration names, and the values are a Nixvim configuration.
These configuration names are just conventions, not special values interpreted by the test runner. Common ones include:
- `defaults`: explicitly sets the plugin or module to the default values documented by Nixvim's settings options. This is mainly useful when those defaults are part of Nixvim's option interface; otherwise `empty` is usually enough.
- `empty`: enables the feature with no additional configuration.
- `example`: uses a configuration that differs from the defaults and reflects something a user might realistically want to do.
- `no-packages`: checks that the feature still evaluates or configures correctly when package/dependency installation is disabled.
You can specify the special `test` attribute in the configuration that will not be interpreted by Nixvim, but only the test runner. The following keys are available:
- `test.runNvim`: Set to `false` to avoid launching Neovim with this configuration and simply build the configuration.