Merge pull request #255 from Pacman99/type-improvements

used coercedTo for typing and improve options
This commit is contained in:
Pacman99 2021-04-21 18:40:13 -07:00 committed by GitHub
commit 8fdd66859c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -18,37 +18,32 @@ let
/* Custom types needed for arguments */ /* Custom types needed for arguments */
moduleType = with types; anything // { moduleType = with types; pathTo (anything // {
inherit (submodule { }) check; inherit (submodule { }) check;
description = "valid module"; description = "valid module";
}; });
overlayType = types.anything // { overlayType = pathTo (types.anything // {
check = builtins.isFunction; check = builtins.isFunction;
description = "valid Nixpkgs overlay"; description = "valid Nixpkgs overlay";
}; });
systemType = types.enum config.supportedSystems; systemType = types.enum config.supportedSystems;
flakeType = with types; (addCheck attrs lib.isStorePath) // { flakeType = with types; (addCheck attrs lib.isStorePath) // {
description = "nix flake"; description = "nix flake";
}; };
# Applys maybeImport during merge and before check # Apply maybeImport during merge and before check
# To simplify apply keys and improve type checking # To simplify apply keys and improve type checking
pathTo = elemType: mkOptionType { pathTo = elemType: coercedTo path maybeImort elemType;
name = "pathTo";
description = "path that evaluates to a(n) ${elemType.name}";
check = x: elemType.check (maybeImport x);
merge = loc: defs:
(mergeDefinitions loc elemType (map
(x: {
inherit (x) file;
value = maybeImport x.value;
})
defs)).mergedValue;
getSubOptions = elemType.getSubOptions;
getSubModules = elemType.getSubModules;
substSubModules = m: pathTo (elemType.substSubModules m);
};
# Accepts single item or a list
# apply keys end up with a list
# This should not be used if expecting a nested list
# all lists will get flattened by this
coercedListOf = elemType:
let coerceToList = x: flatten (singleton x); in
with types; coercedTo elemType coerceToList (listOf elemType);
pathToListOf = x: pathTo (coercedListOf x);
/* Submodules needed for API containers */ /* Submodules needed for API containers */
@ -62,7 +57,7 @@ let
''; '';
}; };
overlays = mkOption { overlays = mkOption {
type = pathTo (listOf overlayType); type = pathToListOf overlayType;
default = [ ]; default = [ ];
description = '' description = ''
overlays to apply to this channel overlays to apply to this channel
@ -70,7 +65,7 @@ let
''; '';
}; };
externalOverlays = mkOption { externalOverlays = mkOption {
type = pathTo (listOf overlayType); type = pathToListOf overlayType;
default = [ ]; default = [ ];
description = '' description = ''
overlays to apply to the channel that don't get exported to the flake output overlays to apply to the channel that don't get exported to the flake output
@ -104,14 +99,21 @@ let
''; '';
}; };
modules = mkOption { modules = mkOption {
type = pathTo moduleType; type = pathToListOf moduleType;
default = [ ]; default = [ ];
description = '' description = ''
The configuration for this config The configuration for this config
''; '';
}; };
};
};
# This is only needed for configDefaults
# modules in each config don't get exported
externalModulesModule = {
options = {
externalModules = mkOption { externalModules = mkOption {
type = pathTo moduleType; type = pathToListOf moduleType;
default = [ ]; default = [ ];
description = '' description = ''
The configuration for this config The configuration for this config
@ -126,14 +128,17 @@ let
includeConfigsModule = { name, ... }: { includeConfigsModule = { name, ... }: {
options = with types; { options = with types; {
configDefaults = mkOption { configDefaults = mkOption {
type = submodule configModule; type = submodule [ configModule externalModulesModule ];
default = { }; default = { };
description = '' description = ''
defaults for all configs Defaults for all configs.
the modules passed under configDefault will be exported
to the '${name}Modules' flake output.
They will also be added to all configs.
''; '';
}; };
configs = mkOption { configs = mkOption {
type = pathTo (attrsOf (submodule configModule)); type = attrsOf (submodule configModule);
default = { }; default = { };
description = '' description = ''
configurations to include in the ${name}Configurations output configurations to include in the ${name}Configurations output
@ -142,30 +147,16 @@ let
}; };
}; };
# Options to import: modules, profiles, suites # profiles and suites - which are profile collections
importsModule = { name, ... }: { profilesModule = { name, ... }: {
options = with types; { options = with types; {
modules = mkOption {
type = pathTo (listOf moduleType);
default = [ ];
apply = lib.pathsToImportedAttrs;
description = ''
list of modules to include in confgurations and export in '${name}Modules' output
'';
};
externalModules = mkOption {
type = pathTo (listOf moduleType);
default = [ ];
apply = lib.pathsToImportedAttrs;
description = ''
list of modules to include in confguration but these are not exported to the '${name}Modules' output
'';
};
profiles = mkOption { profiles = mkOption {
type = path; type = coercedListOf path;
default = "${userFlakeSelf}/profiles"; default = [ ];
defaultText = "\${userFlakeSelf}/profiles"; apply = list:
apply = x: os.mkProfileAttrs (toString x); # Merge a list of profiles to one set
let profileList = map (x: os.mkProfileAttrs (toString x)) list; in
foldl (a: b: a // b) { } profileList;
description = "path to profiles folder that can be collected into suites"; description = "path to profiles folder that can be collected into suites";
}; };
suites = mkOption { suites = mkOption {