From a20fbbc4b9665ec215e7bea061a1d64f6fd652ce Mon Sep 17 00:00:00 2001 From: Gaetan Lepage Date: Sun, 27 Oct 2024 19:56:50 +0100 Subject: [PATCH] CONTRIBUTING: update doc about test.runNvim --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 00592970..fa17350d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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`.