movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-10 03:23:29 +03:00
Code Issues Projects Releases Packages Wiki Activity

lib/types: allow custom submoduleWith descriptions

Browse source 
Currently the only way to set the description for a submodule type is to
use `freeformType`. This is not ideal as it requires setting a
freeform type, and evaluates the submodule config unnecessarily.

Instead, add a `description` argument to `submoduleWith`.
This commit is contained in:
Naïm Favier 2022-05-19 15:15:08 +02:00
parent ddfb78791c
commit ceebdcfc2c
No known key found for this signature in database
GPG key ID: 49B07322580B7EE2
1 changed files with 17 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

23
lib/types.nix
View file

@ -568,6 +568,7 @@ rec {
{ modules { modules
, specialArgs ? {} , specialArgs ? {}
, shorthandOnlyDefinesConfig ? false , shorthandOnlyDefinesConfig ? false
, description ? null
# Internal variable to avoid `_key` collisions regardless # Internal variable to avoid `_key` collisions regardless
# of `extendModules`. Wired through by `evalModules`. # of `extendModules`. Wired through by `evalModules`.
@ -616,10 +617,14 @@ rec {
freeformType = base._module.freeformType; freeformType = base._module.freeformType;
in
mkOptionType rec {
name = "submodule"; name = "submodule";
description = freeformType.description or name;
in
mkOptionType {
inherit name;
description =
if description != null then description
else freeformType.description or name;
check = x: isAttrs x || isFunction x || path.check x; check = x: isAttrs x || isFunction x || path.check x;
merge = loc: defs: merge = loc: defs:
(base.extendModules { (base.extendModules {
@ -645,9 +650,7 @@ rec {
functor = defaultFunctor name // { functor = defaultFunctor name // {
type = types.submoduleWith; type = types.submoduleWith;
payload = { payload = {
modules = modules; inherit modules specialArgs shorthandOnlyDefinesConfig description;
specialArgs = specialArgs;
shorthandOnlyDefinesConfig = shorthandOnlyDefinesConfig;
}; };
binOp = lhs: rhs: { binOp = lhs: rhs: {
modules = lhs.modules ++ rhs.modules; modules = lhs.modules ++ rhs.modules;
@ -664,6 +667,14 @@ rec {
else if lhs.shorthandOnlyDefinesConfig == rhs.shorthandOnlyDefinesConfig else if lhs.shorthandOnlyDefinesConfig == rhs.shorthandOnlyDefinesConfig
then lhs.shorthandOnlyDefinesConfig then lhs.shorthandOnlyDefinesConfig
else throw "A submoduleWith option is declared multiple times with conflicting shorthandOnlyDefinesConfig values"; else throw "A submoduleWith option is declared multiple times with conflicting shorthandOnlyDefinesConfig values";
description =
if lhs.description == null
then rhs.description
else if rhs.description == null
then lhs.description
else if lhs.description == rhs.description
then lhs.description
else throw "A submoduleWith option is declared multiple times with conflicting descriptions";
}; };
}; };
}; };