CONTRIBUTING: update doc about test.runNvim

This commit is contained in:
Gaetan Lepage 2024-10-27 19:56:50 +01:00
parent bc5fc9a896
commit a20fbbc4b9

View file

@ -100,9 +100,9 @@ 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.
You can specify the special `tests` attribute in the configuration that will not be interpreted by nixvim, but only the test runner. The following keys are available:
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:
- `tests.dontRun`: avoid launching this test, simply build the configuration.
- `test.runNvim`: Set to `false` to avoid launching nvim with this configuration and simply build the configuration.
The tests are then runnable with `nix flake check --all-systems`.