Prepare inclusion in nixos-search (#2971)

* Add flake.lock and clean up flake.nix

Add a lockfile to work around https://github.com/NixOS/nix/issues/6541
(and because it's a good idea anyway).

Also use flake-utils, and restrict ourselves to the five platforms
supported by nixpkgs. Otherwise, the IFD for nmd fails on weird
platforms. This fixes `nix flake check`.

Remove the redundant `apps` output, see https://github.com/nix-community/home-manager/pull/2442#issuecomment-1133670487

* nixos,nix-darwin: factor out into a common module

* nixos,nix-darwin: make `home-managers.users` shallowly visible

Make sure the option is included in the NixOS/nix-darwin manual (but the
HM submodule options aren't).

Also add a static description to the HM submodule type so that we don't need to
evaluate the submodules just to build the option manual. This makes
nixos-search able to index the home-manager flake.

Also clean up some TODOs.

* flake: add nmd and nmt

This avoids having to use `pkgs.fetchFromGitLab` in an IFD, which causes
issues when indexing packages with nixos-search because `pkgs` is
instantiated with every platform.

.gitignore

@@ -1,2 +1 @@
-/flake.lock
 /result*

default.nix

@@ -1,6 +1,16 @@
 { pkgs ? import <nixpkgs> { } }:
 
-rec {
+let
+
+  flake = (import
+    (let lock = builtins.fromJSON (builtins.readFile ./flake.lock);
+    in fetchTarball {
+      url =
+        "https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.rev}.tar.gz";
+      sha256 = lock.nodes.flake-compat.locked.narHash;
+    }) { src = ./.; }).defaultNix;
+
+in rec {
   docs = with import ./docs { inherit pkgs; }; {
     html = manual.html;
     manPages = manPages;
@@ -16,4 +26,6 @@ rec {
   nixos = import ./nixos;
 
   path = ./.;
+
+  inherit (flake) inputs;
 }

docs/default.nix

@@ -1,18 +1,10 @@
-{ pkgs
+{ pkgs, nmdSrc ? (import ./.. { }).inputs.nmd
 
-# Note, this should be "the standard library" + HM extensions.
+  # Note, this should be "the standard library" + HM extensions.
 , lib ? import ../modules/lib/stdlib-extended.nix pkgs.lib }:
 
 let
 
-  nmdSrc = pkgs.fetchFromGitLab {
-    name = "nmd";
-    owner = "rycee";
-    repo = "nmd";
-    rev = "9e7a20e6ee3f6751f699f79c0b299390f81f7bcd";
-    sha256 = "1s49gjn1wapcjn0q4gabi8jwp8k5f18354a9c1vji0hfqsaknxzj";
-  };
-
   nmd = import nmdSrc { inherit lib pkgs; };
 
   # Make sure the used package is scrubbed to avoid actually

flake.lock

@@ -0,0 +1,94 @@
+{
+  "nodes": {
+    "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1650374568,
+        "narHash": "sha256-Z+s0J8/r907g149rllvwhb4pKi8Wam5ij0st8PwAh+E=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "b4a34015c698c7793d592d66adbab377907a2be8",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1654230545,
+        "narHash": "sha256-8Vlwf0x8ow6pPOK2a04bT+pxIeRnM1+O0Xv9/CuDzRs=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "236cc2971ac72acd90f0ae3a797f9f83098b17ec",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nmd": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1653339422,
+        "narHash": "sha256-8nc7lcYOgih3YEmRMlBwZaLLJYpLPYKBlewqHqx8ieg=",
+        "owner": "rycee",
+        "repo": "nmd",
+        "rev": "9e7a20e6ee3f6751f699f79c0b299390f81f7bcd",
+        "type": "gitlab"
+      },
+      "original": {
+        "owner": "rycee",
+        "repo": "nmd",
+        "type": "gitlab"
+      }
+    },
+    "nmt": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1648075362,
+        "narHash": "sha256-u36WgzoA84dMVsGXzml4wZ5ckGgfnvS0ryzo/3zn/Pc=",
+        "owner": "rycee",
+        "repo": "nmt",
+        "rev": "d83601002c99b78c89ea80e5e6ba21addcfe12ae",
+        "type": "gitlab"
+      },
+      "original": {
+        "owner": "rycee",
+        "repo": "nmt",
+        "type": "gitlab"
+      }
+    },
+    "root": {
+      "inputs": {
+        "flake-compat": "flake-compat",
+        "nixpkgs": "nixpkgs",
+        "nmd": "nmd",
+        "nmt": "nmt",
+        "utils": "utils"
+      }
+    },
+    "utils": {
+      "locked": {
+        "lastModified": 1653893745,
+        "narHash": "sha256-0jntwV3Z8//YwuOjzhV2sgJJPt+HY6KhU7VZUL0fKZQ=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "1ed9fb1935d260de5fe1c2f7ee0ebaae17ed2fa1",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

flake.nix

@@ -1,43 +1,31 @@
 {
   description = "Home Manager for Nix";
 
-  outputs = { self, nixpkgs }:
+  inputs.nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
-    let
+  inputs.nmd.url = "gitlab:rycee/nmd";
-      # List of systems supported by home-manager binary
+  inputs.nmd.flake = false;
-      supportedSystems = with nixpkgs.lib.platforms; linux ++ darwin;
+  inputs.nmt.url = "gitlab:rycee/nmt";
+  inputs.nmt.flake = false;
 
-      # Function to generate a set based on supported systems
+  inputs.utils.url = "github:numtide/flake-utils";
-      forAllSystems = nixpkgs.lib.genAttrs supportedSystems;
+  inputs.flake-compat.url = "github:edolstra/flake-compat";
+  inputs.flake-compat.flake = false;
 
-      nixpkgsFor = forAllSystems (system: import nixpkgs { inherit system; });
+  outputs = { self, nixpkgs, nmd, utils, ... }:
-    in rec {
+    {
-      nixosModules.home-manager = import ./nixos;
+      nixosModules = rec {
-      nixosModule = self.nixosModules.home-manager;
+        home-manager = import ./nixos;
-
+        default = home-manager;
-      darwinModules.home-manager = import ./nix-darwin;
-      darwinModule = self.darwinModules.home-manager;
-
-      packages = forAllSystems (system:
-        let docs = import ./docs { pkgs = nixpkgsFor.${system}; };
-        in {
-          home-manager = nixpkgsFor.${system}.callPackage ./home-manager { };
-          docs-html = docs.manual.html;
-          docs-manpages = docs.manPages;
-          docs-json = docs.options.json;
-          default = self.packages.${system}.home-manager;
-        });
-
-      # defaultPackage is deprecated as of Nix 2.7.0
-      defaultPackage = forAllSystems (system: self.packages.${system}.default);
-
-      apps = forAllSystems (system: {
-        home-manager = {
-          type = "app";
-          program = "${defaultPackage.${system}}/bin/home-manager";
       };
-      });
+      # deprecated in Nix 2.8
+      nixosModule = self.nixosModules.default;
 
-      defaultApp = forAllSystems (system: apps.${system}.home-manager);
+      darwinModules = rec {
+        home-manager = import ./nix-darwin;
+        default = home-manager;
+      };
+      # unofficial; deprecated in Nix 2.8
+      darwinModule = self.darwinModules.default;
 
       lib = {
         hm = import ./modules/lib { lib = nixpkgs.lib; };
@@ -56,5 +44,22 @@
             };
           };
       };
+    } // utils.lib.eachDefaultSystem (system:
+      let
+        pkgs = import nixpkgs { inherit system; };
+        docs = import ./docs {
+          inherit pkgs;
+          nmdSrc = nmd;
         };
+      in {
+        packages = rec {
+          home-manager = pkgs.callPackage ./home-manager { };
+          docs-html = docs.manual.html;
+          docs-manpages = docs.manPages;
+          docs-json = docs.options.json;
+          default = home-manager;
+        };
+        # deprecated in Nix 2.7
+        defaultPackage = self.packages.${system}.default;
+      });
 }

format

@@ -27,6 +27,5 @@ find . -name '*.nix' \
   ! -path ./modules/programs/bash.nix \
   ! -path ./modules/programs/ssh.nix \
   ! -path ./modules/programs/zsh.nix \
-  ! -path ./nix-darwin/default.nix \
   ! -path ./tests/default.nix \
   -exec nixfmt $CHECK_ARG {} +

home-manager/default.nix

@@ -19,6 +19,7 @@ in runCommand "home-manager" {
   preferLocalBuild = true;
   nativeBuildInputs = [ gettext ];
   meta = with lib; {
+    mainProgram = "home-manager";
     description = "A user environment configurator";
     maintainers = [ maintainers.rycee ];
     platforms = platforms.unix;

integration-common.nix

@@ -0,0 +1,124 @@
+# This module is the common base for the NixOS and nix-darwin modules.
+# For OS-specific configuration, please edit nixos/default.nix or nix-darwin/default.nix instead.
+
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+
+  cfg = config.home-manager;
+
+  extendedLib = import ./modules/lib/stdlib-extended.nix pkgs.lib;
+
+  hmModule' = types.submoduleWith {
+    specialArgs = {
+      lib = extendedLib;
+      osConfig = config;
+      modulesPath = builtins.toString ./modules;
+    } // cfg.extraSpecialArgs;
+    modules = [
+      ({ name, ... }: {
+        imports = import ./modules/modules.nix {
+          inherit pkgs;
+          lib = extendedLib;
+          useNixpkgsModule = !cfg.useGlobalPkgs;
+        };
+
+        config = {
+          submoduleSupport.enable = true;
+          submoduleSupport.externalPackageInstall = cfg.useUserPackages;
+
+          home.username = config.users.users.${name}.name;
+          home.homeDirectory = config.users.users.${name}.home;
+
+          # Make activation script use same version of Nix as system as a whole.
+          # This avoids problems with Nix not being in PATH.
+          home.extraActivationPath = [ config.nix.package ];
+        };
+      })
+    ] ++ cfg.sharedModules;
+  } // {
+    description = "Home Manager module";
+  };
+
+  # TODO: hack until https://github.com/NixOS/nixpkgs/pull/173621 lands
+  hmModule = hmModule' // {
+    substSubModules = m:
+      hmModule'.substSubModules m // {
+        inherit (hmModule') description;
+      };
+  };
+
+in {
+  options.home-manager = {
+    useUserPackages = mkEnableOption ''
+      installation of user packages through the
+      <option>users.users.&lt;name&gt;.packages</option> option
+    '';
+
+    useGlobalPkgs = mkEnableOption ''
+      using the system configuration's <literal>pkgs</literal>
+      argument in Home Manager. This disables the Home Manager
+      options <option>nixpkgs.*</option>
+    '';
+
+    backupFileExtension = mkOption {
+      type = types.nullOr types.str;
+      default = null;
+      example = "backup";
+      description = ''
+        On activation move existing files by appending the given
+        file extension rather than exiting with an error.
+      '';
+    };
+
+    extraSpecialArgs = mkOption {
+      type = types.attrs;
+      default = { };
+      example = literalExpression "{ inherit emacs-overlay; }";
+      description = ''
+        Extra <literal>specialArgs</literal> passed to Home Manager. This
+        option can be used to pass additional arguments to all modules.
+      '';
+    };
+
+    sharedModules = mkOption {
+      type = with types; listOf raw;
+      default = [ ];
+      example = literalExpression "[ { home.packages = [ nixpkgs-fmt ]; } ]";
+      description = ''
+        Extra modules added to all users.
+      '';
+    };
+
+    verbose = mkEnableOption "verbose output on activation";
+
+    users = mkOption {
+      type = types.attrsOf hmModule;
+      default = { };
+      # Prevent the entire submodule being included in the documentation.
+      visible = "shallow";
+      description = ''
+        Per-user Home Manager configuration.
+      '';
+    };
+  };
+
+  config = mkIf (cfg.users != { }) {
+    warnings = flatten (flip mapAttrsToList cfg.users (user: config:
+      flip map config.warnings (warning: "${user} profile: ${warning}")));
+
+    assertions = flatten (flip mapAttrsToList cfg.users (user: config:
+      flip map config.assertions (assertion: {
+        inherit (assertion) assertion;
+        message = "${user} profile: ${assertion.message}";
+      })));
+
+    users.users = mkIf cfg.useUserPackages
+      (mapAttrs (username: usercfg: { packages = [ usercfg.home.path ]; })
+        cfg.users);
+
+    environment.pathsToLink = mkIf cfg.useUserPackages [ "/etc/profile.d" ];
+  };
+}

modules/misc/xdg-desktop-entries.nix

@@ -152,7 +152,7 @@ let
       };
 
       # Required for the assertions
-      # TODO: Remove me once `mkRemovedOptionModule` works correctly with submodules
+      # TODO: Remove me once https://github.com/NixOS/nixpkgs/issues/96006 is fixed
       assertions = mkOption {
         type = types.listOf types.unspecified;
         default = [ ];

nix-darwin/default.nix

@@ -6,140 +6,26 @@ let
 
   cfg = config.home-manager;
 
-  extendedLib = import ../modules/lib/stdlib-extended.nix pkgs.lib;
+in {
+  imports = [ ../integration-common.nix ];
 
-  hmModule = types.submoduleWith {
+  config = mkMerge [
-    specialArgs = {
+    { home-manager.extraSpecialArgs.darwinConfig = config; }
-      lib = extendedLib;
+    (mkIf (cfg.users != { }) {
-      darwinConfig = config;
+      system.activationScripts.postActivation.text = concatStringsSep "\n"
-      osConfig = config;
+        (mapAttrsToList (username: usercfg: ''
-      modulesPath = builtins.toString ../modules;
-    } // cfg.extraSpecialArgs;
-    modules = [
-      ({ name, ... }: {
-        imports = import ../modules/modules.nix {
-          inherit pkgs;
-          lib = extendedLib;
-          useNixpkgsModule = !cfg.useGlobalPkgs;
-        };
-
-        config = {
-          submoduleSupport.enable = true;
-          submoduleSupport.externalPackageInstall = cfg.useUserPackages;
-
-          home.username = config.users.users.${name}.name;
-          home.homeDirectory = config.users.users.${name}.home;
-
-          # Make activation script use same version of Nix as system as a whole.
-          # This avoids problems with Nix not being in PATH.
-          home.extraActivationPath = [ config.nix.package ];
-        };
-      })
-    ] ++ cfg.sharedModules;
-  };
-
-in
-
-{
-  options = {
-    home-manager = {
-      useUserPackages = mkEnableOption ''
-        installation of user packages through the
-        <option>users.users.&lt;name?&gt;.packages</option> option.
-      '';
-
-      useGlobalPkgs = mkEnableOption ''
-        using the system configuration's <literal>pkgs</literal>
-        argument in Home Manager. This disables the Home Manager
-        options <option>nixpkgs.*</option>
-      '';
-
-      backupFileExtension = mkOption {
-        type = types.nullOr types.str;
-        default = null;
-        example = "backup";
-        description = ''
-          On activation move existing files by appending the given
-          file extension rather than exiting with an error.
-        '';
-      };
-
-      extraSpecialArgs = mkOption {
-        type = types.attrs;
-        default = { };
-        example = literalExpression "{ inherit emacs-overlay; }";
-        description = ''
-          Extra <literal>specialArgs</literal> passed to Home Manager. This
-          option can be used to pass additional arguments to all modules.
-        '';
-      };
-
-      sharedModules = mkOption {
-        type = with types;
-          # TODO: use types.raw once this PR is merged: https://github.com/NixOS/nixpkgs/pull/132448
-          listOf (mkOptionType {
-            name = "submodule";
-            inherit (submodule { }) check;
-            merge = lib.options.mergeOneOption;
-            description = "Home Manager modules";
-          });
-        default = [ ];
-        example = literalExpression "[ { home.packages = [ nixpkgs-fmt ]; } ]";
-        description = ''
-          Extra modules added to all users.
-        '';
-      };
-
-      verbose = mkEnableOption "verbose output on activation";
-
-      users = mkOption {
-        type = types.attrsOf hmModule;
-        default = {};
-        # Set as not visible to prevent the entire submodule being included in
-        # the documentation.
-        visible = false;
-        description = ''
-          Per-user Home Manager configuration.
-        '';
-      };
-    };
-  };
-
-  config = mkIf (cfg.users != {}) {
-    warnings =
-      flatten (flip mapAttrsToList cfg.users (user: config:
-        flip map config.warnings (warning:
-          "${user} profile: ${warning}"
-        )
-      ));
-
-    assertions =
-      flatten (flip mapAttrsToList cfg.users (user: config:
-        flip map config.assertions (assertion:
-          {
-            inherit (assertion) assertion;
-            message = "${user} profile: ${assertion.message}";
-          }
-        )
-      ));
-
-    users.users = mkIf cfg.useUserPackages (
-      mapAttrs (username: usercfg: {
-        packages = [ usercfg.home.path ];
-      }) cfg.users
-    );
-
-    environment.pathsToLink = mkIf cfg.useUserPackages [ "/etc/profile.d" ];
-
-    system.activationScripts.postActivation.text =
-      concatStringsSep "\n" (mapAttrsToList (username: usercfg: ''
           echo Activating home-manager configuration for ${username}
-        sudo -u ${username} -s --set-home ${pkgs.writeShellScript "activation-${username}" ''
+          sudo -u ${username} -s --set-home ${
+            pkgs.writeShellScript "activation-${username}" ''
               ${lib.optionalString (cfg.backupFileExtension != null)
-            "export HOME_MANAGER_BACKUP_EXT=${lib.escapeShellArg cfg.backupFileExtension}"}
+              "export HOME_MANAGER_BACKUP_EXT=${
+                lib.escapeShellArg cfg.backupFileExtension
+              }"}
               ${lib.optionalString cfg.verbose "export VERBOSE=1"}
               exec ${usercfg.home.activationPackage}/activate
-        ''}
+            ''
+          }
         '') cfg.users);
-  };
+    })
+  ];
 }

nixos/default.nix

@@ -6,128 +6,27 @@ let
 
   cfg = config.home-manager;
 
-  extendedLib = import ../modules/lib/stdlib-extended.nix pkgs.lib;
-
-  hmModule = types.submoduleWith {
-    specialArgs = {
-      lib = extendedLib;
-      nixosConfig = config;
-      osConfig = config;
-      modulesPath = builtins.toString ../modules;
-    } // cfg.extraSpecialArgs;
-    modules = [
-      ({ name, ... }: {
-        imports = import ../modules/modules.nix {
-          inherit pkgs;
-          lib = extendedLib;
-          useNixpkgsModule = !cfg.useGlobalPkgs;
-        };
-
-        config = {
-          submoduleSupport.enable = true;
-          submoduleSupport.externalPackageInstall = cfg.useUserPackages;
-
-          # The per-user directory inside /etc/profiles is not known by
-          # fontconfig by default.
-          fonts.fontconfig.enable = cfg.useUserPackages
-            && config.fonts.fontconfig.enable;
-
-          home.username = config.users.users.${name}.name;
-          home.homeDirectory = config.users.users.${name}.home;
-
-          # Make activation script use same version of Nix as system as a whole.
-          # This avoids problems with Nix not being in PATH.
-          home.extraActivationPath = [ config.nix.package ];
-        };
-      })
-    ] ++ cfg.sharedModules;
-  };
-
   serviceEnvironment = optionalAttrs (cfg.backupFileExtension != null) {
     HOME_MANAGER_BACKUP_EXT = cfg.backupFileExtension;
   } // optionalAttrs cfg.verbose { VERBOSE = "1"; };
 
 in {
-  options = {
+  imports = [ ../integration-common.nix ];
+
+  config = mkMerge [
+    {
       home-manager = {
-      useUserPackages = mkEnableOption ''
+        extraSpecialArgs.nixosConfig = config;
-        installation of user packages through the
-        <option>users.users.&lt;name&gt;.packages</option> option
-      '';
 
-      useGlobalPkgs = mkEnableOption ''
+        sharedModules = [{
-        using the system configuration's <literal>pkgs</literal>
+          # The per-user directory inside /etc/profiles is not known by
-        argument in Home Manager. This disables the Home Manager
+          # fontconfig by default.
-        options <option>nixpkgs.*</option>
+          fonts.fontconfig.enable = cfg.useUserPackages
-      '';
+            && config.fonts.fontconfig.enable;
-
+        }];
-      backupFileExtension = mkOption {
-        type = types.nullOr types.str;
-        default = null;
-        example = "backup";
-        description = ''
-          On activation move existing files by appending the given
-          file extension rather than exiting with an error.
-        '';
       };
-
+    }
-      extraSpecialArgs = mkOption {
+    (mkIf (cfg.users != { }) {
-        type = types.attrs;
-        default = { };
-        example = literalExpression "{ inherit emacs-overlay; }";
-        description = ''
-          Extra <literal>specialArgs</literal> passed to Home Manager. This
-          option can be used to pass additional arguments to all modules.
-        '';
-      };
-
-      sharedModules = mkOption {
-        type = with types;
-        # TODO: use types.raw once this PR is merged: https://github.com/NixOS/nixpkgs/pull/132448
-          listOf (mkOptionType {
-            name = "submodule";
-            inherit (submodule { }) check;
-            merge = lib.options.mergeOneOption;
-            description = "Home Manager modules";
-          });
-        default = [ ];
-        example = literalExpression "[ { home.packages = [ nixpkgs-fmt ]; } ]";
-        description = ''
-          Extra modules added to all users.
-        '';
-      };
-
-      verbose = mkEnableOption "verbose output on activation";
-
-      users = mkOption {
-        type = types.attrsOf hmModule;
-        default = { };
-        # Set as not visible to prevent the entire submodule being included in
-        # the documentation.
-        visible = false;
-        description = ''
-          Per-user Home Manager configuration.
-        '';
-      };
-    };
-  };
-
-  config = mkIf (cfg.users != { }) {
-    warnings = flatten (flip mapAttrsToList cfg.users (user: config:
-      flip map config.warnings (warning: "${user} profile: ${warning}")));
-
-    assertions = flatten (flip mapAttrsToList cfg.users (user: config:
-      flip map config.assertions (assertion: {
-        inherit (assertion) assertion;
-        message = "${user} profile: ${assertion.message}";
-      })));
-
-    users.users = mkIf cfg.useUserPackages
-      (mapAttrs (username: usercfg: { packages = [ usercfg.home.path ]; })
-        cfg.users);
-
-    environment.pathsToLink = mkIf cfg.useUserPackages [ "/etc/profile.d" ];
-
       systemd.services = mapAttrs' (_: usercfg:
         let username = usercfg.home.username;
         in nameValuePair ("home-manager-${utils.escapeSystemdPath username}") {
@@ -181,5 +80,6 @@ in {
             in "${setupEnv} ${usercfg.home.activationPackage}";
           };
         }) cfg.users;
-  };
+    })
+  ];
 }

tests/default.nix

@@ -4,12 +4,7 @@ let
 
   lib = import ../modules/lib/stdlib-extended.nix pkgs.lib;
 
-  nmt = pkgs.fetchFromGitLab {
+  inherit ((import ./.. { }).inputs) nmt;
-    owner = "rycee";
-    repo = "nmt";
-    rev = "d83601002c99b78c89ea80e5e6ba21addcfe12ae";
-    sha256 = "1xzwwxygzs1cmysg97hzd285r7n1g1lwx5y1ar68gwq07a1rczmv";
-  };
 
   modules = import ../modules/modules.nix {
     inherit lib pkgs;