nix-community.nixvim/tests/enable-except-in-tests.nix
traxys 6d7e429537
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
2024-02-15 14:27:45 +01:00

41 lines
896 B
Nix

{
pkgs,
mkTestDerivationFromNixvimModule,
makeNixvimWithModule,
}: let
module = {helpers, ...}: {
plugins.image.enable = helpers.enableExceptInTests;
};
inTest = mkTestDerivationFromNixvimModule {
name = "enable-except-in-tests-test";
inherit pkgs module;
};
notInTest = let
nvim = makeNixvimWithModule {
inherit pkgs module;
};
in
pkgs.runCommand "enable-except-in-tests-not-in-test" {
printConfig = "${nvim}/bin/nixvim-print-init";
} ''
if ! "$printConfig" | grep 'require("image").setup'; then
echo "image.nvim is not present in the configuration"
echo -e "configuration:\n$($printConfig)"
exit 1
fi
touch $out
'';
in
pkgs.linkFarm "enable-except-in-tests" [
{
name = "in-test";
path = inTest;
}
{
name = "not-in-test";
path = notInTest;
}
]