tests: Introduce a way to disable options when running in tests (#1095)

In our basic template we used to provide a check based on
`mkTestDerivationFromNvim`. The issue with this check (that is handled
correctly internally) is that some plugins _can't_ be used in the test
environment, for example image.nvim like in #1085.

This commit introduces a new function to generate such checks,
`mkTestDerivationFromNixvimModule`, that wraps a nixvim configuration
instead of a built nvim instance.

Then a configuration can rely on the newly added
`helpers.enableExceptInTests` attribute to disable parts of the
configuration depending if it is evaluated in tests or in a real final
configuration.

Resolves #1085
This commit is contained in:
traxys 2024-02-15 14:27:45 +01:00 committed by GitHub
parent 0cef34c889
commit 6d7e429537
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
15 changed files with 92 additions and 20 deletions

View file

@ -29,7 +29,7 @@
}: let
nixvimLib = nixvim.lib.${system};
nixvim' = nixvim.legacyPackages.${system};
nvim = nixvim'.makeNixvimWithModule {
nixvimModule = {
inherit pkgs;
module = config;
# You can use `extraSpecialArgs` to pass additional arguments to your module files
@ -37,13 +37,11 @@
# inherit (inputs) foo;
};
};
nvim = nixvim'.makeNixvimWithModule nixvimModule;
in {
checks = {
# Run `nix flake check .` to verify that your config is not broken
default = nixvimLib.check.mkTestDerivationFromNvim {
inherit nvim;
name = "A nixvim configuration";
};
default = nixvimLib.check.mkTestDerivationFromNixvimModule nixvimModule;
};
packages = {