Skip to content

Commit

Permalink
home-manager: set module class to "homeManager"
Browse files Browse the repository at this point in the history
This enables a module system feature documented here:
https://nixos.org/manual/nixpkgs/stable/index.html#module-system-lib-evalModules-param-class

For example, it allows a mistake to be caught, which is loading a
NixOS module into home-manager. This only works when the offending
module declares what it's for with a `_class` attribute.

It is not expected that users declare the `_type`, because the payoff
is small. It is only expected to be set by generic code, such as
functions or libraries that help with the "publishing" of modules
(e.g. flake-parts, flake-utils).

The class feature has been available in the module system since
NixOS/nixpkgs#197547, merged May 6, 2023. It
has been part of all releases since 23.05-beta. The last NixOS release
that did _not_ support it has been end-of-life for close to a year
now.

Example:

    (lib.homeManagerConfiguration {
      pkgs = nixpkgs.legacyPackages.x86_64-linux;
      modules = [{ _class = "nixos"; imports = [ ./foo.nix ]; }];
    }).activation-script

Corresponding error:

    error: The module <unknown-file> was imported into homeManager instead of nixos.

(`<unknown-file>` can be improved by also setting `_file`, if known; a
much older feature)

PR nix-community#5339
  • Loading branch information
roberth authored and rycee committed Apr 27, 2024
1 parent 0c5704e commit 26e72d8
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,11 @@ let
hmPath = toString ./..;

buildOptionsDocs = args@{ modules, includeModuleSystemOptions ? true, ... }:
let options = (lib.evalModules { inherit modules; }).options;
let
options = (lib.evalModules {
inherit modules;
class = "homeManager";
}).options;
in pkgs.buildPackages.nixosOptionsDoc ({
options = if includeModuleSystemOptions then
options
Expand Down Expand Up @@ -160,6 +164,7 @@ in {
inherit lib pkgs;
check = false;
} ++ [ scrubbedPkgsModule ];
class = "homeManager";
};
in builtins.toJSON result.config.meta.maintainers);
}
1 change: 1 addition & 0 deletions modules/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ let

rawModule = extendedLib.evalModules {
modules = [ configuration ] ++ hmModules;
class = "homeManager";
specialArgs = { modulesPath = builtins.toString ./.; } // extraSpecialArgs;
};

Expand Down
1 change: 1 addition & 0 deletions nixos/common.nix
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ let

hmModule = types.submoduleWith {
description = "Home Manager module";
class = "homeManager";
specialArgs = {
lib = extendedLib;
osConfig = config;
Expand Down

0 comments on commit 26e72d8

Please sign in to comment.