fix(nix): use a separate option for nested devshell configurations

Author: deemp

flake.nix

@@ -63,21 +63,21 @@
       );
 
       devShells = eachSystem (
-        { devshell, ... }:
+        { devshell, system, ... }:
         {
           default = devshell.mkShell {
             bash.extra = ''
               export MDBOOK_SERVER_ADDRESS="http://localhost:3000"
             '';
-            commands = {
+            commandGroups = {
               packages = [
                 "diffutils" # used by golangci-lint
                 "goreleaser"
               ];
               scripts = [
                 {
                   prefix = "nix run .#";
-                  inherit packages;
+                  packages = packages.${system};
                   helps.docs = ''Run mdBook server at "$MDBOOK_SERVER_ADDRESS"'';
                   interpolates.docs = true;
                 }
@@ -89,7 +89,7 @@
               utilites = [
                 [
                   "GitHub utility"
-                  "gitAndTools.hub"
+                  "hub"
                 ]
                 [
                   "golang linter"
@@ -111,10 +111,10 @@
         }
       );
 
-      apps.default = devShells.default.flakeApp;
+      # apps.default = devShells.default.flakeApp;
 
       checks = eachSystem (
-        { pkgs, ... }:
+        { devshell, pkgs, ... }:
         with pkgs.lib;
         pipe { } [
           (

modules/commands.nix

@@ -7,19 +7,43 @@
 }:
 let
   inherit (import ../nix/commands/lib.nix { inherit pkgs options config; })
-    commandsType
-    commandToPackage
+    commandsFlatType
+    commandsNestedType
+    normalizeCommandsFlat
+    normalizeCommandsNested
     devshellMenuCommandName
+    commandToPackage
     commandsToMenu
     ;
 in
 {
   options.commands = lib.mkOption {
-    type = commandsType;
+    type = commandsFlatType;
     default = [ ];
     description = ''
       Add commands to the environment.
     '';
+    example = lib.literalExpression ''
+      [
+        {
+          help = "print hello";
+          name = "hello";
+          command = "echo hello";
+        }
+        {
+          package = "nixfmt";
+          category = "formatter";
+        }
+      ]
+    '';
+  };
+
+  options.commandGroups = lib.mkOption {
+    type = commandsNestedType;
+    default = { };
+    description = ''
+      Add commands to the environment.
+    '';
     example = lib.literalExpression ''
       {
         packages = [
@@ -37,7 +61,7 @@ in
           }
         ];
         utilites = [
-          [ "GitHub utility" "gitAndTools.hub" ]
+          [ "GitHub utility" "hub" ]
           [ "golang linter" "golangci-lint" ]
         ];
       }
@@ -48,13 +72,18 @@ in
     {
       help = "prints this menu";
       name = devshellMenuCommandName;
-      command = commandsToMenu config.devshell.menu config.commands;
+      command = commandsToMenu config.devshell.menu config.devshell.commands;
     }
   ];
 
+  config.devshell.commands =
+    normalizeCommandsFlat config.commands ++ normalizeCommandsNested config.commandGroups;
+
   # Add the commands to the devshell packages. Either as wrapper scripts, or
   # the whole package.
-  config.devshell.packages = lib.filter (x: x != null) (map commandToPackage config.commands);
+  config.devshell.packages = lib.filter (x: x != null) (
+    map commandToPackage config.devshell.commands
+  );
 
   # config.devshell.motd = "$(motd)";
 }

modules/devshell.nix

@@ -19,7 +19,10 @@ let
   # environment.
   strOrPackage = import ../nix/strOrPackage.nix { inherit lib pkgs; };
 
-  inherit (import ../nix/commands/lib.nix { inherit pkgs options; }) devshellMenuCommandName;
+  inherit (import ../nix/commands/lib.nix { inherit pkgs options; })
+    devshellMenuCommandName
+    commandsFlatType
+    ;
 
   # Use this to define a flake app for the environment.
   mkFlakeApp = bin: {
@@ -319,6 +322,15 @@ in
       '';
     };
 
+    commands = mkOption {
+      type = commandsFlatType;
+      internal = true;
+      default = [ ];
+      description = ''
+        Merged normalized `commands` and `commandGroups`.
+      '';
+    };
+
     packages = mkOption {
       type = types.listOf strOrPackage;
       default = [ ];

modules/modules-docs.nix

@@ -122,7 +122,6 @@ let
   inherit (import ../nix/commands/lib.nix { inherit pkgs options; })
     mkLocSuffix
     nestedOptionsType
-    flatOptionsType
     ;
 
   # TODO: display values like TOML instead.

nix/commands/commandsType.nix

@@ -3,30 +3,36 @@
   pkgs ? import ../nixpkgs.nix { inherit system; },
   options ? { },
 }:
-with pkgs.lib;
-with builtins;
 let
+  inherit (builtins)
+    concatStringsSep
+    hasAttr
+    head
+    isAttrs
+    isList
+    isString
+    ;
+
+  inherit (pkgs.lib)
+    attrByPath
+    collect
+    flatten
+    isDerivation
+    last
+    mapAttrsRecursiveCond
+    mapAttrsToList
+    parseDrvName
+    pipe
+    ;
+
+  inherit (pkgs.lib.options) unknownModule;
+
   inherit (import ./types.nix { inherit pkgs options; })
     commandsFlatType
     commandsNestedType
     resolveKey
     strOrPackage
     ;
-in
-rec {
-  mergeDefs =
-    loc: defs:
-    let
-      t1 = commandsFlatType;
-      t2 = commandsNestedType;
-      defsFlat = t1.merge loc (map (d: d // { value = if isList d.value then d.value else [ ]; }) defs);
-      defsNested = t2.merge loc (
-        map (d: d // { value = if !(isList d.value) then d.value else { }; }) defs
-      );
-    in
-    {
-      inherit defsFlat defsNested;
-    };
 
   extractHelp = arg: if isList arg then head arg else null;
 
@@ -55,15 +61,13 @@ rec {
     else
       alternative;
 
-  normalizeCommandsFlat_ =
+  mergeCommandsFlat =
     {
-      file ? unknownModule,
+      arg,
       loc ? [ ],
-      arg ? [ ],
+      file ? unknownModule,
     }:
     pipe arg [
-      (value: (mergeDefs loc [ { inherit file value; } ]).defsFlat)
-      (map (config: flattenNonAttrsOrElse config config))
       flatten
       (map (value: {
         inherit file;
@@ -72,6 +76,10 @@ rec {
       (commandsFlatType.merge loc)
     ];
 
+  normalizeCommandsFlat' = map (config: flattenNonAttrsOrElse config config);
+
+  normalizeCommandsFlat = arg: mergeCommandsFlat { arg = normalizeCommandsFlat' arg; };
+
   highlyUnlikelyAttrName = "adjd-laso-msle-copq-pcod";
 
   collectLeaves =
@@ -89,15 +97,21 @@ rec {
       (map (x: x.${highlyUnlikelyAttrName}))
     ];
 
-  normalizeCommandsNested_ =
-    {
-      file ? unknownModule,
-      loc ? [ ],
-      arg ? { },
-    }:
+  normalizeCommandsNested' =
+    arg:
     pipe arg [
       # typecheck and augment configs with missing attributes (if a config is an attrset)
-      (value: (mergeDefs loc [ { inherit file value; } ]).defsNested)
+      (
+        x:
+        commandsNestedType.merge
+          [ ]
+          [
+            {
+              file = unknownModule;
+              value = x;
+            }
+          ]
+      )
       (mapAttrsToList (
         category:
         map (
@@ -166,44 +180,21 @@ rec {
           )
         )
       ))
-      flatten
-      (map (value: {
-        inherit file;
-        value = [ value ];
-      }))
-      (commandsFlatType.merge loc)
     ];
 
-  normalizeCommandsNested = arg: normalizeCommandsNested_ { inherit arg; };
-
-  commandsType =
-    let
-      t1 = commandsFlatType;
-      t2 = commandsNestedType;
-      either = types.either t1 t2;
-    in
-    either
-    // rec {
-      name = "commandsType";
-      description = "(${t1.description}) or (${t2.description})";
-      merge =
-        loc: defs:
-        let
-          inherit (mergeDefs loc defs) defsFlat defsNested;
-          defsFlatNormalized = normalizeCommandsFlat_ {
-            arg = defsFlat;
-            inherit loc;
-          };
-          defsNestedNormalized = normalizeCommandsNested_ {
-            arg = defsNested;
-            inherit loc;
-          };
-          defsMerged = defsFlatNormalized ++ defsNestedNormalized;
-        in
-        defsMerged;
-      getSubOptions = prefix: {
-        "${t1.name}" = t1.getSubOptions prefix;
-        "${t2.name}" = t2.getSubOptions prefix;
-      };
-    };
+  normalizeCommandsNested = arg: mergeCommandsFlat { arg = normalizeCommandsNested' arg; };
+in
+{
+  inherit
+    extractHelp
+    resolveName
+    flattenNonAttrsOrElse
+    highlyUnlikelyAttrName
+    collectLeaves
+    mergeCommandsFlat
+    normalizeCommandsFlat'
+    normalizeCommandsFlat
+    normalizeCommandsNested'
+    normalizeCommandsNested
+    ;
 }

nix/commands/devshell.nix

@@ -122,8 +122,6 @@ rec {
               ...
             }:
             let
-              len = maxCommandLength - (lib.stringLength name);
-
               nameWidth = toString maxCommandLength;
               helpWidth = toString (config.devshell.menu.width - (maxCommandLength + 5));
               helpHeight = toString 100;

nix/commands/flatOptions.nix

@@ -20,16 +20,13 @@ in
 
   name = mkOption {
     type = types.nullOr (
-      types.str
-      // (
-        let
-          regex = "[^$\r\n]+";
-        in
-        {
-          description = "string matching ${regex}";
-          check = x: lib.isString x && match regex x != null;
-        }
-      )
+      let
+        regex = "[^$\r\n]+";
+      in
+      lib.types.addCheck types.str (x: lib.isString x && match regex x != null)
+      // {
+        description = "string matching ${regex}";
+      }
     );
     default = null;
     description = ''