Add the tool "nixos-typecheck" that can check an option declaration to:

- Enforce that an option declaration has a "defaultText" if and only if the
   type of the option derives from "package", "packageSet" or "nixpkgsConfig"
   and if a "default" attribute is defined.

 - Enforce that the value of the "example" attribute is wrapped with "literalExample"
   if the type of the option derives from "package", "packageSet" or "nixpkgsConfig".

 - Warn if a "defaultText" is defined in an option declaration if the type of
   the option does not derive from "package", "packageSet" or "nixpkgsConfig".

 - Warn if no "type" is defined in an option declaration.
This commit is contained in:
Thomas Strobel
2016-02-20 01:47:01 +01:00
parent c483224c82
commit cad8957eab
24 changed files with 703 additions and 127 deletions

View File

@@ -20,8 +20,13 @@
, # !!! See comment about args in lib/modules.nix
specialArgs ? {}
, modules
, # Pass through a configuration of the internal modules declared
# in lib/modules.nix.
_module ? {}
, # !!! See comment about typeInference in lib/modules.nix
typeInference ? null
, # !!! See comment about check in lib/modules.nix
check ? true
check ? null
, prefix ? []
, lib ? import ../../lib
}:
@@ -41,13 +46,17 @@ let
};
};
internalModule = { _module = (_module
// (if isNull check then {} else { inherit check; })
// (if isNull typeInference then {} else { inherit typeInference; })); };
in rec {
# Merge the option definitions in all modules, forming the full
# system configuration.
inherit (lib.evalModules {
inherit prefix check;
modules = modules ++ extraModules ++ baseModules ++ [ pkgsModule ];
inherit prefix;
modules = modules ++ extraModules ++ baseModules ++ [ pkgsModule ] ++ [ internalModule ];
args = extraArgs;
specialArgs = { modulesPath = ../modules; } // specialArgs;
}) config options;