lib/modules: Add attrArgName

hercules-ci · Jun 14, 2022 · d06f5fa · d06f5fa
1 parent 9ef09e0
commit d06f5fa
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 3 deletions.
diff --git a/lib/modules.nix b/lib/modules.nix
@@ -113,6 +113,7 @@ rec {
                   args ? {}
                 , # This would be remove in the future, Prefer _module.check option instead.
                   check ? true
+                , attrArgName ? "name"
                 }:
     let
       withWarnings = x:
@@ -341,15 +342,17 @@ rec {
         modules ? [],
         specialArgs ? {},
         prefix ? [],
+        attrArgName ? "name",
         }:
           evalModules (evalModulesArgs // {
             modules = regularModules ++ modules;
             specialArgs = evalModulesArgs.specialArgs or {} // specialArgs;
             prefix = extendArgs.prefix or evalModulesArgs.prefix or [];
+            inherit attrArgName;
           });
 
       type = lib.types.submoduleWith {
-        inherit modules specialArgs;
+        inherit modules specialArgs attrArgName;
       };
 
       result = withWarnings {

diff --git a/lib/tests/modules.sh b/lib/tests/modules.sh
@@ -337,6 +337,8 @@ checkConfigOutput 'ok' config.freeformItems.foo.bar ./adhoc-freeformType-survive
 # because of an `extendModules` bug, issue 168767.
 checkConfigOutput '^1$' config.sub.specialisation.value ./extendModules-168767-imports.nix
 
+checkConfigOutput '^"foo=qux,bar=xyz"$' config.result ./nested-extendModules-with-name.nix
+
 cat <<EOF
 ====== module tests ======
 $pass Pass

diff --git a/lib/tests/modules/nested-extendModules-with-name.nix b/lib/tests/modules/nested-extendModules-with-name.nix
@@ -0,0 +1,33 @@
+{ config, extendModules, lib, ... }:
+let
+  inherit (lib) mkOption types;
+  inherit (types) attrsOf submodule;
+in
+{
+  options = {
+    withKey = mkOption {
+      type = attrsOf (
+        submodule ({ name, ... }: {
+          options.value = mkOption {
+            type = attrsOf (
+              (extendModules {
+                attrArgName = name;
+              }).type
+            );
+          };
+        })
+      );
+    };
+    res = mkOption {
+      type = types.str;
+    };
+    result = mkOption {
+      default = config.withKey.foo.value.qux.withKey.bar.value.xyz.res;
+    };
+  };
+  config = {
+    withKey.foo.value.qux.withKey.bar.value.xyz = { foo, bar, lib, config, ... }: {
+      res = "foo=" + foo + ",bar=" + bar;
+    };
+  };
+}
diff --git a/lib/types.nix b/lib/types.nix
@@ -570,6 +570,7 @@ rec {
       { modules
       , specialArgs ? {}
       , shorthandOnlyDefinesConfig ? false
+      , attrArgName ? "name"
       , description ? null
       }@attrs:
       let
@@ -599,7 +600,7 @@ rec {
             # &gt; and &lt; wouldn't be encoded correctly so the encoded values
             # would be used, and use of `<` and `>` would break the XML document.
             # It shouldn't cause an issue since this is cosmetic for the manual.
-            _module.args.name = lib.mkOptionDefault "‹name›";
+            _module.args.${attrArgName} = lib.mkOptionDefault "‹name›";
           }] ++ modules;
         };
 
@@ -616,7 +617,7 @@ rec {
         check = x: isAttrs x || isFunction x || path.check x;
         merge = loc: defs:
           (base.extendModules {
-            modules = [ { _module.args.name = last loc; } ] ++ allModules defs;
+            modules = [ { _module.args.${attrArgName} = last loc; } ] ++ allModules defs;
             prefix = loc;
           }).config;
         emptyValue = { value = {}; };