mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-20 16:15:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

docs/contributing: update documentation for running single tests

Browse source 
docs/contributing: update documentation for running single tests

docs/contributing: update documentation for running single tests
This commit is contained in:
bpatel347 2024-11-11 15:29:25 -05:00 • committed by nix-infra-bot
parent c892aa2073
commit 7dc65b2d98
1 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -104,7 +104,13 @@ You can specify the special `test` attribute in the configuration that will not
- `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`.
> [!TIP]
> A single test can be run with `nix develop --command tests --interactive`. This launches the testing suite in interactive mode, allowing you to easily search for and select specific tests to run.
> [!WARNING]
> Running the entire test suite locally is not necessary in most cases. Instead, you may find it more efficient to focus on specific tests relevant to your changes, as Continuous Integration (CI) will run the full test suite on any Pull Requests (PRs) you open. This ensures comprehensive coverage without requiring the full suite to be run locally every time.
The full test suite can still be run locally with `nix flake check --all-systems` if needed.
There are a second set of tests, unit tests for nixvim itself, defined in `tests/lib-tests.nix` that use the `pkgs.lib.runTests` framework.