Merge #156

156: Improve Home Manager support: profiles/suites, modules, extern, flake outputs r=Pacman99 a=Pacman99

A really simple method of implementing #119. 

This relies on a feature that I added in home-manager master for module options of extraSpecialArgs and sharedModules, nix-community/home-manager#1793. I could try and get that backported to 20.09. But I thought I'd get some feedback on these changes first.

Co-authored-by: Pacman99 <pachum99@gmail.com>

extern/default.nix

@@ -1,7 +1,4 @@
 { inputs }: with inputs;
-let
-  hmModules = { };
-in
 {
   modules = [
     home.nixosModules.home-manager
@@ -19,9 +16,15 @@ in
 
   # passed to all nixos modules
   specialArgs = {
-    inherit hmModules;
-
     overrideModulesPath = "${override}/nixos/modules";
     hardware = nixos-hardware.nixosModules;
   };
+
+  # added to home-manager
+  userModules = [
+  ];
+
+  # passed to all home-manager modules
+  userSpecialArgs = {
+  };
 }

flake.lock

@@ -118,16 +118,15 @@
         ]
       },
       "locked": {
-        "lastModified": 1612902587,
-        "narHash": "sha256-VZ7Z1OMFf5ReObu3CCVBsC2DWloTYDjqW1onUKejVrE=",
+        "lastModified": 1616318638,
+        "narHash": "sha256-E6ABXtzw6bHmrIirB1sJL6S2MEa3sfcvRLzRa92frCo=",
         "owner": "nix-community",
         "repo": "home-manager",
-        "rev": "209566c752c4428c7692c134731971193f06b37c",
+        "rev": "ddcd476603dfd3388b1dc8234fa9d550156a51f5",
         "type": "github"
       },
       "original": {
         "owner": "nix-community",
-        "ref": "release-20.09",
         "repo": "home-manager",
         "type": "github"
       }

flake.nix

@@ -18,7 +18,7 @@
       devshell.url = "github:numtide/devshell";
       flake-compat.url = "github:BBBSnowball/flake-compat/pr-1";
       flake-compat.flake = false;
-      home.url = "github:nix-community/home-manager/release-20.09";
+      home.url = "github:nix-community/home-manager";
       home.inputs.nixpkgs.follows = "nixos";
       naersk.url = "github:nmattia/naersk";
       naersk.inputs.nixpkgs.follows = "override";
@@ -47,10 +47,16 @@
             });
           });
 
+        homeConfigurations = os.mkHomeConfigurations;
+
         nixosModules =
           let moduleList = import ./modules/module-list.nix;
           in lib.pathsToImportedAttrs moduleList;
 
+        homeModules =
+          let moduleList = import ./users/modules/module-list.nix;
+          in lib.pathsToImportedAttrs moduleList;
+
         overlay = import ./pkgs;
         overlays = lib.pathsToImportedAttrs (lib.pathsIn ./overlays);
 
@@ -82,9 +88,6 @@
           devShell = import ./shell {
             inherit self system;
           };
-
-          legacyPackages.hmActivationPackages =
-            os.mkHomeActivation;
         }
       );
     in

hosts/default.nix

@@ -35,8 +35,13 @@ let
       };
 
     global = { config, ... }: {
-      home-manager.useGlobalPkgs = true;
-      home-manager.useUserPackages = true;
+      home-manager = {
+        useGlobalPkgs = true;
+        useUserPackages = true;
+
+        extraSpecialArgs = extern.userSpecialArgs // { suites = suites.user; };
+        sharedModules = extern.userModules ++ (builtins.attrValues self.homeModules);
+      };
 
       hardware.enableRedistributableFirmware = lib.mkDefault true;
 
@@ -67,7 +72,7 @@ let
     flakeModules = { imports = builtins.attrValues self.nixosModules ++ extern.modules; };
   };
 
-  specialArgs = extern.specialArgs // { inherit suites; };
+  specialArgs = extern.specialArgs // { suites = suites.system; };
 
   mkHostConfig = hostName:
     let

lib/devos/default.nix

@@ -19,7 +19,7 @@
 
   devosSystem = dev.callLibs ./devosSystem.nix;
 
-  mkHomeActivation = dev.callLibs ./mkHomeActivation.nix;
+  mkHomeConfigurations = dev.callLibs ./mkHomeConfigurations.nix;
 
   mkPackages = dev.callLibs ./mkPackages.nix;
 }

lib/devos/devosSystem.nix

@@ -73,10 +73,29 @@ lib.nixosSystem (args // {
             })
           ];
         })).config;
+      hmConfig = (lib.nixosSystem
+        (args // {
+          modules = moduleList ++ [
+            ({ config, ... }: {
+              home-manager.useUserPackages = lib.mkForce false;
+              home-manager.sharedModules = [
+                {
+                  home.packages = config.environment.systemPackages;
+                  home.sessionVariables = {
+                    inherit (config.environment.sessionVariables) NIX_PATH;
+                  };
+                  xdg.configFile."nix/registry.json".text =
+                    config.environment.etc."nix/registry.json".text;
+                }
+              ];
+            })
+          ];
+        })).config;
     in
     moduleList ++ [{
       system.build = {
         iso = isoConfig.system.build.isoImage;
+        homes = hmConfig.home-manager.users;
       };
     }];
 })

lib/devos/mkHomeActivation.nix

@@ -1,12 +0,0 @@
-{ lib, self, ... }:
-
-let hmConfigs =
-  lib.mapAttrs
-    (_: config: config.config.home-manager.users)
-    self.nixosConfigurations;
-in
-lib.mapAttrs
-  (_: x: lib.mapAttrs
-    (_: cfg: cfg.home.activationPackage)
-    x)
-  hmConfigs

lib/devos/mkHomeConfigurations.nix

@@ -0,0 +1,12 @@
+{ lib, self, ... }:
+
+with lib;
+let
+  mkHomes = host: config:
+    mapAttrs' (user: v: nameValuePair "${user}@${host}" v)
+    config.config.system.build.homes;
+
+  hmConfigs = mapAttrs mkHomes self.nixosConfigurations;
+
+in
+foldl recursiveUpdate {} (attrValues hmConfigs)

shell/flk.sh

@@ -81,7 +81,7 @@ case "$1" in
     ;;
 
   "home")
-    ref="$DEVSHELL_ROOT/#hmActivationPackages.$2.$3"
+    ref="$DEVSHELL_ROOT/#homeConfigurations.$3@$2.home.activationPackage"
 
     if [[ "$4" == "switch" ]]; then
       nix build "$ref" && result/activate &&

suites/default.nix

@@ -3,6 +3,7 @@ let
   inherit (lib) dev;
 
   profiles = dev.os.mkProfileAttrs (toString ../profiles);
+  userProfiles = dev.os.mkProfileAttrs (toString ../users/profiles);
   users = dev.os.mkProfileAttrs (toString ../users);
 
   allProfiles =
@@ -17,7 +18,18 @@ let
   suites = with profiles; rec {
     base = [ users.nixos users.root ];
   };
+
+  # available as 'suites' within the home-manager configuration
+  userSuites = with userProfiles; rec {
+    base = [ direnv git ];
+  };
+
 in
-lib.mapAttrs (_: v: dev.os.profileMap v) suites // {
-  inherit allProfiles allUsers;
+{
+  system = lib.mapAttrs (_: v: dev.os.profileMap v) suites // {
+    inherit allProfiles allUsers;
+  };
+  user = lib.mapAttrs (_: v: dev.os.profileMap v) userSuites // {
+    allProfiles = userProfiles;
+  };
 }

users/README.md

@@ -22,10 +22,17 @@ your users. For a fully fleshed out example, check out the developers personal
 
 ```
 
+## Home Manager
+Home Manager support follows the same principles as regular nixos configurations.
+All modules defined in [user modules](./modules/module-list.nix) will be imported to 
+Home Manager. All profiles are availabe in [suites](../suites/default.nix) as userProfiles.
+The `userSuites` output will be available in your Home Manager Configuration as
+the special argument, `suites`.
+
 ## External Usage
 You can easily use the defined home-manager configurations outside of NixOS
-using the `hmActivations` meta-package defined in the flakes `legacyPackages`
-output. The [flk](../doc/flk) helper script makes this even easier.
+using the `homeConfigurations` flake output. The [flk](../doc/flk) helper 
+script makes this even easier.
 
 This is great for keeping your environment consistent across Unix systems,
 including OSX.
@@ -42,7 +49,7 @@ flk home NixOS nixos switch
 ### Manually from outside the project:
 ```sh
 # build
-nix build "github:divnix/devos#hmActivationPackages.NixOS.nixos"
+nix build "github:divnix/devos#homeConfigurations.nixos@NixOS.home.activationPackage"
 
 # activate
 ./result/activate && unlink result

users/modules/module-list.nix

@@ -0,0 +1 @@
+[]

users/nixos/default.nix

@@ -1,7 +1,7 @@
 { ... }:
 {
-  home-manager.users.nixos = {
-    imports = [ ../profiles/git ../profiles/direnv ];
+  home-manager.users.nixos = { suites, ... }: {
+    imports = suites.base;
   };
 
   users.users.nixos = {