Merge pull request #10 from snowfallorg/feat/home-manager

feat: home-manager support
This commit is contained in:
Jake Hamilton 2023-08-17 00:53:14 -07:00 committed by GitHub
commit 0115ebd171
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
20 changed files with 878 additions and 44 deletions

196
README.md
View file

@ -38,11 +38,12 @@ cd config
2. Create a new flake with one of the templates from [@snowfallorg/templates](https://github.com/snowfallorg/templates). 2. Create a new flake with one of the templates from [@snowfallorg/templates](https://github.com/snowfallorg/templates).
| Name | Description | | Name | Description |
| --------- | ------------------------------------------------- | | --------- | ---------------------------------------------------- |
| `system` | A NixOS system and modules ready to modify. | | `system` | A NixOS system and modules ready to modify. |
| `package` | A Nix Flake that exports packages and an overlay. | | `package` | A Nix Flake that exports packages and an overlay. |
| `module` | A Nix Flake that exports NixOS modules. | | `module` | A Nix Flake that exports NixOS modules. |
| `lib` | A Nix Flake that exports a custom `lib` | | `lib` | A Nix Flake that exports a custom `lib` |
| `empty` | A basic Nix Flake for you to customize from scratch. |
```bash ```bash
# For example, to use the system template. # For example, to use the system template.
@ -195,6 +196,14 @@ snowfall-root/
├─ modules/ (optional modules) ├─ modules/ (optional modules)
│ │ │ │
│ │ A directory named after the `platform` type that will be used for modules within.
│ │
│ │ Supported platforms are:
│ │ - nixos
│ │ - darwin
│ │ - home
│ └─ <platform>/
│ │
│ │ Any (nestable) directory name. The name of the directory will be the │ │ Any (nestable) directory name. The name of the directory will be the
│ │ name of the module. │ │ name of the module.
│ └─ **/ │ └─ **/
@ -246,6 +255,37 @@ snowfall-root/
│ │ │ │
│ │ A NixOS module for your system's configuration. │ │ A NixOS module for your system's configuration.
│ └─ default.nix │ └─ default.nix
├─ homes/ (optional homes configurations)
│ │
│ │ A directory named after the `home` type that will be used for all homes within.
│ │
│ │ The architecture is any supported architecture of NixPkgs, for example:
│ │ - x86_64
│ │ - aarch64
│ │ - i686
│ │
│ │ The format is any supported NixPkgs format *or* a format provided by either nix-darwin
│ │ or nixos-generators. However, in order to build systems with nix-darwin or nixos-generators,
│ │ you must add `darwin` and `nixos-generators` inputs to your flake respectively. Here
│ │ are some example formats:
│ │ - linux
│ │ - darwin
│ │ - iso
│ │ - install-iso
│ │ - do
│ │ - vmware
│ │
│ │ With the architecture and format together (joined by a hyphen), you get the name of the
│ │ directory for the home type.
│ └─ <architecture>-<format>/
│ │
│ │ A directory that contains a single home's configuration. The directory name
│ │ will be the name of the home.
│ └─ <home-name>/
│ │
│ │ A NixOS module for your home's configuration.
│ └─ default.nix
``` ```
#### Default Flake #### Default Flake
@ -526,6 +566,48 @@ type. See the following table for a list of supported formats from NixOS Generat
| vm-nogui | Same as vm, but without a GUI | | vm-nogui | Same as vm, but without a GUI |
| vmware | VMWare image (VMDK) | | vmware | VMWare image (VMDK) |
#### Home Manager
Snowfall Lib supports configuring [Home Manager](https://github.com/nix-community/home-manager)
for both standalone use and for use as a module with NixOS or nix-darwin. To use this feature,
your flake must include `home-manager` as an input.
```nix
{
description = "My Flake";
inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-22.11";
snowfall-lib = {
url = "github:snowfallorg/lib";
inputs.nixpkgs.follows = "nixpkgs";
};
# In order to use Home Manager.
home-manager = {
url = "github:nix-community/home-manager";
inputs.nixpkgs.follows = "nixpkgs";
};
};
outputs = inputs:
# This is an example and in your actual flake you can use `snowfall-lib.mkFlake`
# directly unless you explicitly need a feature of `lib`.
let
lib = inputs.snowfall-lib.mkLib {
# You must pass in both your flake's inputs and the root directory of
# your flake.
inherit inputs;
src = ./.;
};
in
# No additional configuration is required to use this feature, you only
# have to add home-manager to your flake inputs.
lib.mkFlake { };
}
```
### `lib.snowfall.flake` ### `lib.snowfall.flake`
Helpers related to Nix flakes. Helpers related to Nix flakes.
@ -1162,6 +1244,24 @@ Result:
"iso" "iso"
``` ```
#### `lib.snowfall.system.get-inferred-system-name`
Get the name of a system based on its file path.
Type: `Path -> String`
Usage:
```nix
get-inferred-system-name "/systems/my-system/default.nix"
```
Result:
```nix
"my-system"
```
#### `lib.snowfall.system.get-target-systems-metadata` #### `lib.snowfall.system.get-target-systems-metadata`
Get structured data about all systems for a given target. Get structured data about all systems for a given target.
@ -1261,7 +1361,7 @@ Type: `Attrs -> Attrs`
Usage: Usage:
```nix ```nix
create-systems { hosts.my-host.specialArgs.x = true; modules = [ my-shared-module ]; } create-systems { hosts.my-host.specialArgs.x = true; modules.nixos = [ my-shared-module ]; }
``` ```
Result: Result:
@ -1270,6 +1370,98 @@ Result:
{ my-host = <flake-utils-plus-system-configuration>; } { my-host = <flake-utils-plus-system-configuration>; }
``` ```
### `lib.snowfall.home`
#### `lib.snowfall.home.split-user-and-host`
Get the user and host from a combined string.
Type: `String -> Attrs`
Usage:
```nix
split-user-and-host "myuser@myhost"
```
Result:
```nix
{ user = "myuser"; host = "myhost"; }
```
#### `lib.snowfall.home.create-home`
Create a home.
Type: `Attrs -> Attrs`
Usage:
```nix
create-home { path = ./homes/my-home; }
```
Result:
```nix
<flake-utils-plus-home-configuration>
```
#### `lib.snowfall.home.create-homes`
Create all available homes.
Type: `Attrs -> Attrs`
Usage:
```nix
create-homes { users."my-user@my-system".specialArgs.x = true; modules = [ my-shared-module ]; }
```
Result:
```nix
{ "my-user@my-system" = <flake-utils-plus-home-configuration>; }
```
#### `lib.snowfall.home.get-target-homes-metadata`
Get structured data about all homes for a given target.
Type: `String -> [Attrs]`
Usage:
```nix
get-target-homes-metadata ./homes
```
Result:
```nix
[ { system = "x86_64-linux"; name = "my-home"; path = "/homes/x86_64-linux/my-home";} ]
```
#### `lib.snowfall.home.create-home-system-modules`
Create system modules for home-manager integration.
Type: `Attrs -> [Module]`
Usage:
```nix
create-home-system-modules { users."my-user@my-system".specialArgs.x = true; modules = [ my-shared-module ]; }
```
Result:
```nix
[Module]
```
### `lib.snowfall.package` ### `lib.snowfall.package`
Utilities for working with flake packages. Utilities for working with flake packages.

View file

@ -27,10 +27,10 @@
# A convenience wrapper to create the library and then call `lib.mkFlake`. # A convenience wrapper to create the library and then call `lib.mkFlake`.
# Usage: mkFlake { inherit inputs; src = ./.; ... } # Usage: mkFlake { inherit inputs; src = ./.; ... }
# result: <flake-outputs> # result: <flake-outputs>
mkFlake = flake-and-lib-options@{ inputs, src, ... }: mkFlake = flake-and-lib-options@{ inputs, src, snowfall ? { }, ... }:
let let
lib = mkLib { lib = mkLib {
inherit inputs src; inherit inputs src snowfall;
}; };
flake-options = builtins.removeAttrs flake-and-lib-options [ "inputs" "src" ]; flake-options = builtins.removeAttrs flake-and-lib-options [ "inputs" "src" ];
in in
@ -38,5 +38,17 @@
in in
{ {
inherit mkLib mkFlake; inherit mkLib mkFlake;
nixosModules = {
user = ./modules/nixos/user/default.nix;
};
darwinModules = {
user = ./modules/darwin/user/default.nix;
};
homeModules = {
user = ./modules/home/user/default.nix;
};
}; };
} }

View file

@ -1,6 +1,7 @@
{ core-inputs { core-inputs
, user-inputs , user-inputs
, snowfall-lib , snowfall-lib
, snowfall-config
}: }:
let let

View file

@ -6,6 +6,11 @@ core-inputs:
user-options: user-options:
let let
raw-snowfall-config = user-options.snowfall or { };
snowfall-config = raw-snowfall-config // {
root = raw-snowfall-config.root or user-options.src;
};
user-inputs = user-options.inputs // { src = user-options.src; }; user-inputs = user-options.inputs // { src = user-options.src; };
inherit (core-inputs.nixpkgs.lib) assertMsg fix filterAttrs mergeAttrs fold recursiveUpdate callPackageWith; inherit (core-inputs.nixpkgs.lib) assertMsg fix filterAttrs mergeAttrs fold recursiveUpdate callPackageWith;
@ -60,7 +65,7 @@ let
snowfall-lib = fix (snowfall-lib: snowfall-lib = fix (snowfall-lib:
let let
attrs = { attrs = {
inherit snowfall-lib core-inputs user-inputs; inherit snowfall-lib snowfall-config core-inputs user-inputs;
}; };
libs = builtins.map libs = builtins.map
(dir: import "${snowfall-lib-root}/${dir}" attrs) (dir: import "${snowfall-lib-root}/${dir}" attrs)

View file

@ -1,6 +1,7 @@
{ core-inputs { core-inputs
, user-inputs , user-inputs
, snowfall-lib , snowfall-lib
, snowfall-config
}: }:
let let
@ -47,6 +48,7 @@ rec {
"templates" "templates"
"package-namespace" "package-namespace"
"alias" "alias"
"snowfall"
]; ];
# Transform an attribute set of inputs into an attribute set where # Transform an attribute set of inputs into an attribute set where
@ -72,15 +74,30 @@ rec {
package-namespace = full-flake-options.package-namespace or "internal"; package-namespace = full-flake-options.package-namespace or "internal";
custom-flake-options = flake.without-snowfall-options full-flake-options; custom-flake-options = flake.without-snowfall-options full-flake-options;
alias = full-flake-options.alias or { }; alias = full-flake-options.alias or { };
systems = snowfall-lib.system.create-systems (full-flake-options.systems or { }); homes = snowfall-lib.home.create-homes (full-flake-options.homes or { });
hosts = snowfall-lib.attrs.merge-shallow [ (full-flake-options.systems.hosts or { }) systems ]; systems = snowfall-lib.system.create-systems {
systems = (full-flake-options.systems or { });
homes = (full-flake-options.homes or { });
};
hosts = snowfall-lib.attrs.merge-shallow [ (full-flake-options.systems.hosts or { }) systems homes ];
templates = snowfall-lib.template.create-templates { templates = snowfall-lib.template.create-templates {
overrides = (full-flake-options.templates or { }); overrides = (full-flake-options.templates or { });
alias = alias.templates or { }; alias = alias.templates or { };
}; };
modules = snowfall-lib.module.create-modules { nixos-modules = snowfall-lib.module.create-modules {
overrides = (full-flake-options.modules or { }); src = snowfall-lib.fs.get-snowfall-file "modules/nixos";
alias = alias.modules or { }; overrides = (full-flake-options.modules.nixos or { });
alias = alias.modules.nixos or { };
};
darwin-modules = snowfall-lib.module.create-modules {
src = snowfall-lib.fs.get-snowfall-file "modules/darwin";
overrides = (full-flake-options.modules.darwin or { });
alias = alias.modules.darwin or { };
};
home-modules = snowfall-lib.module.create-modules {
src = snowfall-lib.fs.get-snowfall-file "modules/home";
overrides = (full-flake-options.modules.home or { });
alias = alias.modules.home or { };
}; };
overlays = snowfall-lib.overlay.create-overlays { overlays = snowfall-lib.overlay.create-overlays {
inherit package-namespace; inherit package-namespace;
@ -120,7 +137,9 @@ rec {
lib = snowfall-lib.internal.user-lib; lib = snowfall-lib.internal.user-lib;
inputs = snowfall-lib.flake.without-src user-inputs; inputs = snowfall-lib.flake.without-src user-inputs;
nixosModules = modules; nixosModules = nixos-modules;
darwinModules = darwin-modules;
homeModules = home-modules;
channelsConfig = full-flake-options.channels-config or { }; channelsConfig = full-flake-options.channels-config or { };

View file

@ -1,6 +1,7 @@
{ core-inputs { core-inputs
, user-inputs , user-inputs
, snowfall-lib , snowfall-lib
, snowfall-config
}: }:
let let

View file

@ -1,6 +1,7 @@
{ core-inputs { core-inputs
, user-inputs , user-inputs
, snowfall-lib , snowfall-lib
, snowfall-config
}: }:
let let
@ -31,7 +32,7 @@ in
# Type: Path -> Path # Type: Path -> Path
# Usage: get-snowfall-file "systems" # Usage: get-snowfall-file "systems"
# result: "/user-source/snowfall-dir/systems" # result: "/user-source/snowfall-dir/systems"
get-snowfall-file = path: "${user-inputs.snowfall.root or user-inputs.src}/${path}"; get-snowfall-file = path: "${snowfall-config.root}/${path}";
# Get a file path relative to the this flake. # Get a file path relative to the this flake.
# Type: Path -> Path # Type: Path -> Path

310
lib/home/default.nix Normal file
View file

@ -0,0 +1,310 @@
{ core-inputs
, user-inputs
, snowfall-lib
, snowfall-config
}:
let
inherit (core-inputs.nixpkgs.lib)
assertMsg
foldl
head
tail
concatMap
optionalAttrs
optional
mkIf
filterAttrs
mapAttrs'
mkMerge
mapAttrsToList
optionals
mkDefault
mkAliasDefinitions
mkAliasAndWrapDefinitions
mkOption
types;
user-homes-root = snowfall-lib.fs.get-snowfall-file "homes";
user-modules-root = snowfall-lib.fs.get-snowfall-file "modules";
in
{
home = rec {
# Modules in home-manager expect `hm` to be available directly on `lib` itself.
home-lib = snowfall-lib.internal.system-lib.extend (final: prev:
# @NOTE(jakehamilton): This order is important, this library's extend and other utilities must write
# _over_ the original `system-lib`.
snowfall-lib.internal.system-lib
// prev
// {
hm = snowfall-lib.internal.system-lib.home-manager.hm;
});
# Get the user and host from a combined string.
# Type: String -> Attrs
# Usage: split-user-and-host "myuser@myhost"
# result: { user = "myuser"; host = "myhost"; }
split-user-and-host = target:
let
raw-name-parts = builtins.split "@" target;
name-parts = builtins.filter builtins.isString raw-name-parts;
user = builtins.elemAt name-parts 0;
host =
if builtins.length name-parts > 1 then
builtins.elemAt name-parts 1
else
"";
in
{
inherit user host;
};
# Create a home.
# Type: Attrs -> Attrs
# Usage: create-home { path = ./homes/my-home; }
# result: <flake-utils-plus-home-configuration>
create-home =
{ path
, name ? builtins.unsafeDiscardStringContext (snowfall-lib.system.get-inferred-system-name path)
, modules ? [ ]
, specialArgs ? { }
, channelName ? "nixpkgs"
, system ? "x86_64-linux"
}:
let
user-metadata = split-user-and-host name;
# @NOTE(jakehamilton): home-manager has trouble with `pkgs` recursion if it isn't passed in here.
pkgs = user-inputs.self.pkgs.${system}.${channelName} // { lib = home-lib; };
lib = home-lib;
in
assert assertMsg (user-inputs ? home-manager) "In order to create home-manager configurations, you must include `home-manager` as a flake input.";
assert assertMsg (user-metadata.host != "") "Snowfall Lib homes must be named with the format: user@system";
{
inherit channelName system;
output = "homeConfigurations";
modules = [
path
../../modules/home/user/default.nix
] ++ modules;
specialArgs = {
inherit name;
inherit (user-metadata) user host;
format = "home";
inputs = snowfall-lib.flake.without-src user-inputs;
# @NOTE(jakehamilton): home-manager has trouble with `pkgs` recursion if it isn't passed in here.
inherit pkgs lib;
};
builder = args:
user-inputs.home-manager.lib.homeManagerConfiguration
((builtins.removeAttrs args [ "system" "specialArgs" ]) // {
inherit pkgs lib;
modules = args.modules ++ [
(module-args: import ./nix-registry-module.nix (module-args // {
inherit user-inputs core-inputs;
}))
({
snowfallorg.user.name = mkDefault user-metadata.user;
})
];
extraSpecialArgs = specialArgs // args.specialArgs;
});
};
# Get structured data about all homes for a given target.
# Type: String -> [Attrs]
# Usage: get-target-homes-metadata ./homes
# result: [ { system = "x86_64-linux"; name = "my-home"; path = "/homes/x86_64-linux/my-home";} ]
get-target-homes-metadata = target:
let
homes = snowfall-lib.fs.get-directories target;
existing-homes = builtins.filter (home: builtins.pathExists "${home}/default.nix") homes;
create-home-metadata = path: {
path = "${path}/default.nix";
# We are building flake outputs based on file contents. Nix doesn't like this
# so we have to explicitly discard the string's path context to allow us to
# use the name as a variable.
name = builtins.unsafeDiscardStringContext (builtins.baseNameOf path);
# We are building flake outputs based on file contents. Nix doesn't like this
# so we have to explicitly discard the string's path context to allow us to
# use the name as a variable.
system = builtins.unsafeDiscardStringContext (builtins.baseNameOf target);
};
home-configurations = builtins.map create-home-metadata existing-homes;
in
home-configurations;
# Create all available homes.
# Type: Attrs -> Attrs
# Usage: create-homes { users."my-user@my-system".specialArgs.x = true; modules = [ my-shared-module ]; }
# result: { "my-user@my-system" = <flake-utils-plus-home-configuration>; }
create-homes = homes:
let
targets = snowfall-lib.fs.get-directories user-homes-root;
target-homes-metadata = concatMap get-target-homes-metadata targets;
user-home-modules = snowfall-lib.module.create-modules {
src = "${user-modules-root}/home";
};
user-home-modules-list = mapAttrsToList
(module-path: module: args@{ pkgs, ... }: (module args) // {
_file = "${user-homes-root}/${module-path}/default.nix";
})
user-home-modules;
create-home' = home-metadata:
let
inherit (home-metadata) name;
overrides = homes.users.${name} or { };
in
{
"${name}" = create-home (overrides // home-metadata // {
modules = user-home-modules-list ++ (homes.users.${name}.modules or [ ]) ++ (homes.modules or [ ]);
});
};
created-homes = foldl (homes: home-metadata: homes // (create-home' home-metadata)) { } target-homes-metadata;
in
created-homes;
# Create system modules for home-manager integration.
# Type: Attrs -> [Module]
# Usage: create-home-system-modules { users."my-user@my-system".specialArgs.x = true; modules = [ my-shared-module ]; }
# result: [Module]
create-home-system-modules = users:
let
created-users = create-homes users;
user-home-modules = snowfall-lib.module.create-modules {
src = "${user-modules-root}/home";
};
shared-modules = mapAttrsToList
(module-path: module: {
_file = "${user-modules-root}/home/${module-path}/default.nix";
config = {
home-manager.sharedModules = [ module ];
};
})
user-home-modules;
snowfall-user-home-module = {
_file = "virtual:snowfallorg/modules/home/user/default.nix";
config = {
home-manager.sharedModules = [
../../modules/home/user/default.nix
];
};
};
extra-special-args-module =
args@{ config
, pkgs
, system ? pkgs.system
, target ? system
, format ? "home"
, host ? ""
, virtual ? (snowfall-lib.system.is-virtual target)
, systems ? { }
, ...
}:
{
_file = "virtual:snowfallorg/home/extra-special-args";
config = {
home-manager.extraSpecialArgs = {
inherit system target format virtual systems host;
lib = home-lib;
inputs = snowfall-lib.flake.without-src user-inputs;
};
};
};
system-modules = builtins.map
(name:
let
created-user = created-users.${name};
user-module = head created-user.modules;
other-modules = users.users.${name}.modules or [ ];
user-name = created-user.specialArgs.user;
in
args@{ config
, options
, pkgs
, host ? ""
, ...
}:
let
host-matches = created-user.specialArgs.host == host;
# @NOTE(jakehamilton): To conform to the config structure of home-manager, we have to
# remap the options coming from `snowfallorg.user.<name>.home.config` since `mkAliasDefinitions`
# does not let us target options within a submodule.
wrap-user-options = user-option:
if (user-option ? "_type") && user-option._type == "merge" then
user-option // {
contents = builtins.map
(merge-entry:
merge-entry.${user-name}.home.config or { }
)
user-option.contents;
}
else
(builtins.trace ''
=============
Snowfall Lib:
Option value for `snowfallorg.user.${user-name}` was not detected to be merged.
Please report the issue on GitHub with a link to your configuration so we can debug the problem:
https://github.com/snowfallorg/lib/issues/new
=============
'')
user-option;
in
{
_file = "virtual:snowfallorg/home/user/${name}";
config = mkIf host-matches {
# Initialize user information.
snowfallorg.user.${user-name}.home.config = {
snowfallorg.user = {
enable = true;
name = mkDefault user-name;
};
};
home-manager = {
users.${user-name} = mkAliasAndWrapDefinitions wrap-user-options options.snowfallorg.user;
# sharedModules = other-modules ++ optional config.snowfallorg.user.${user-name}.home.enable wrapped-user-module;
sharedModules = other-modules ++ optional config.snowfallorg.user.${user-name}.home.enable user-module;
};
};
}
)
(builtins.attrNames created-users);
in
[
extra-special-args-module
snowfall-user-home-module
]
++ (users.modules or [ ])
++ shared-modules
++ system-modules;
};
}

View file

@ -0,0 +1,11 @@
# This code is adapted from flake-utils-plus:
# https://github.com/gytis-ivaskevicius/flake-utils-plus/blob/2bf0f91643c2e5ae38c1b26893ac2927ac9bd82a/lib/options.nix
{ lib, config, user-inputs, core-inputs, ... }:
{
disabledModules = [
# The module from flake-utils-plus only works on NixOS and nix-darwin. For home-manager
# to build, this module needs to be disabled.
"${core-inputs.flake-utils-plus}/lib/options.nix"
];
}

View file

@ -1,6 +1,7 @@
{ core-inputs { core-inputs
, user-inputs , user-inputs
, snowfall-lib , snowfall-lib
, snowfall-config
}: }:
let let

View file

@ -1,6 +1,7 @@
{ core-inputs { core-inputs
, user-inputs , user-inputs
, snowfall-lib , snowfall-lib
, snowfall-config
}: }:
let let
@ -16,7 +17,7 @@ in
# Usage: create-modules { src = ./my-modules; overrides = { inherit another-module; }; alias = { default = "another-module" }; } # Usage: create-modules { src = ./my-modules; overrides = { inherit another-module; }; alias = { default = "another-module" }; }
# result: { another-module = ...; my-module = ...; default = ...; } # result: { another-module = ...; my-module = ...; default = ...; }
create-modules = create-modules =
{ src ? user-modules-root { src ? "${user-modules-root}/nixos"
, overrides ? { } , overrides ? { }
, alias ? { } , alias ? { }
}: }:
@ -36,7 +37,9 @@ in
modules-metadata = builtins.map create-module-metadata user-modules; modules-metadata = builtins.map create-module-metadata user-modules;
merge-modules = modules: metadata: merge-modules = modules: metadata:
modules // { modules // {
${metadata.name} = args: # @NOTE(jakehamilton): home-manager *requires* modules to specify named arguments or it will not
# pass values in. For this reason we must specify things like `pkgs` as a named attribute.
${metadata.name} = args@{ pkgs, ... }:
let let
system = args.system or args.pkgs.system; system = args.system or args.pkgs.system;
target = args.target or system; target = args.target or system;

View file

@ -1,6 +1,7 @@
{ core-inputs { core-inputs
, user-inputs , user-inputs
, snowfall-lib , snowfall-lib
, snowfall-config
}: }:
let let

View file

@ -1,6 +1,7 @@
{ core-inputs { core-inputs
, user-inputs , user-inputs
, snowfall-lib , snowfall-lib
, snowfall-config
}: }:
let let

View file

@ -1,6 +1,7 @@
{ core-inputs { core-inputs
, user-inputs , user-inputs
, snowfall-lib , snowfall-lib
, snowfall-config
}: }:
let let

View file

@ -1,6 +1,7 @@
{ core-inputs { core-inputs
, user-inputs , user-inputs
, snowfall-lib , snowfall-lib
, snowfall-config
}: }:
let let

View file

@ -1,25 +1,30 @@
{ core-inputs { core-inputs
, user-inputs , user-inputs
, snowfall-lib , snowfall-lib
, snowfall-config
}: }:
let let
inherit (builtins) dirOf baseNameOf; inherit (builtins) dirOf baseNameOf;
inherit (core-inputs.nixpkgs.lib) assertMsg fix hasInfix concatMap foldl; inherit (core-inputs.nixpkgs.lib) assertMsg fix hasInfix concatMap foldl optionals singleton;
virtual-systems = import ./virtual-systems.nix; virtual-systems = import ./virtual-systems.nix;
user-systems-root = snowfall-lib.fs.get-snowfall-file "systems"; user-systems-root = snowfall-lib.fs.get-snowfall-file "systems";
user-modules-root = snowfall-lib.fs.get-snowfall-file "modules"; user-modules-root = snowfall-lib.fs.get-snowfall-file "modules";
in
{
system = rec {
# Get the name of a system based on its file path.
# Type: Path -> String
# Usage: get-inferred-system-name "/systems/my-system/default.nix"
# result: "my-system"
get-inferred-system-name = path: get-inferred-system-name = path:
if snowfall-lib.path.has-file-extension "nix" path then if snowfall-lib.path.has-file-extension "nix" path then
snowfall-lib.path.get-parent-directory path snowfall-lib.path.get-parent-directory path
else else
baseNameOf path; baseNameOf path;
in
{
system = rec {
# Check whether a named system is macOS. # Check whether a named system is macOS.
# Type: String -> Bool # Type: String -> Bool
# Usage: is-darwin "x86_64-linux" # Usage: is-darwin "x86_64-linux"
@ -85,20 +90,27 @@ in
let let
virtual-system-type = get-virtual-system-type target; virtual-system-type = get-virtual-system-type target;
virtual-system-builder = args: virtual-system-builder = args:
assert (assertMsg (user-inputs ? nixos-generators) "In order to create virtual systems, you must include `nixos-generators` as a flake input."); assert assertMsg (user-inputs ? nixos-generators) "In order to create virtual systems, you must include `nixos-generators` as a flake input.";
user-inputs.nixos-generators.nixosGenerate user-inputs.nixos-generators.nixosGenerate
(args // { (args // {
format = virtual-system-type; format = virtual-system-type;
specialArgs = args.specialArgs // { specialArgs = args.specialArgs // {
format = virtual-system-type; format = virtual-system-type;
}; };
modules = args.modules ++ [
../../modules/nixos/user/default.nix
];
}); });
darwin-system-builder = args: darwin-system-builder = args:
assert (assertMsg (user-inputs ? darwin) "In order to create virtual systems, you must include `darwin` as a flake input."); assert assertMsg (user-inputs ? darwin) "In order to create virtual systems, you must include `darwin` as a flake input.";
user-inputs.darwin.lib.darwinSystem ((builtins.removeAttrs args [ "system" ]) // { user-inputs.darwin.lib.darwinSystem
((builtins.removeAttrs args [ "system" "modules" ]) // {
specialArgs = args.specialArgs // { specialArgs = args.specialArgs // {
format = "darwin"; format = "darwin";
}; };
modules = args.modules ++ [
../../modules/darwin/user/default.nix
];
}); });
linux-system-builder = args: linux-system-builder = args:
core-inputs.nixpkgs.lib.nixosSystem core-inputs.nixpkgs.lib.nixosSystem
@ -106,6 +118,9 @@ in
specialArgs = args.specialArgs // { specialArgs = args.specialArgs // {
format = "linux"; format = "linux";
}; };
modules = args.modules ++ [
../../modules/nixos/user/default.nix
];
}); });
in in
if virtual-system-type != "" then if virtual-system-type != "" then
@ -158,17 +173,26 @@ in
, builder ? get-system-builder target , builder ? get-system-builder target
, output ? get-system-output target , output ? get-system-output target
, systems ? { } , systems ? { }
, homes ? { }
}: }:
let let
lib = snowfall-lib.internal.system-lib; lib = snowfall-lib.internal.system-lib;
home-system-modules = snowfall-lib.home.create-home-system-modules homes;
home-manager-module =
if is-darwin system then
user-inputs.home-manager.darwinModules.home-manager
else
user-inputs.home-manager.nixosModules.home-manager;
home-manager-modules = [ home-manager-module ] ++ home-system-modules;
in in
{ {
inherit channelName system builder output; inherit channelName system builder output;
modules = [ path ] ++ modules; modules = [ path ] ++ modules ++ (optionals (user-inputs ? home-manager) home-manager-modules);
specialArgs = specialArgs // { specialArgs = specialArgs // {
inherit target system name systems lib; inherit target system systems lib;
host = name;
virtual = (get-virtual-system-type target) != ""; virtual = (get-virtual-system-type target) != "";
inputs = snowfall-lib.flake.without-src user-inputs; inputs = snowfall-lib.flake.without-src user-inputs;
@ -177,21 +201,41 @@ in
# Create all available systems. # Create all available systems.
# Type: Attrs -> Attrs # Type: Attrs -> Attrs
# Usage: create-systems { hosts.my-host.specialArgs.x = true; modules = [ my-shared-module ]; } # Usage: create-systems { hosts.my-host.specialArgs.x = true; modules.nixos = [ my-shared-module ]; }
# result: { my-host = <flake-utils-plus-system-configuration>; } # result: { my-host = <flake-utils-plus-system-configuration>; }
create-systems = systems: create-systems = { systems ? { }, homes ? { } }:
let let
targets = snowfall-lib.fs.get-directories user-systems-root; targets = snowfall-lib.fs.get-directories user-systems-root;
target-systems-metadata = concatMap get-target-systems-metadata targets; target-systems-metadata = concatMap get-target-systems-metadata targets;
user-modules = snowfall-lib.fs.get-default-nix-files-recursive user-modules-root; user-nixos-modules = snowfall-lib.module.create-modules {
src = "${user-modules-root}/nixos";
};
user-darwin-modules = snowfall-lib.module.create-modules {
src = "${user-modules-root}/darwin";
};
nixos-modules = systems.modules.nixos or [ ];
darwin-modules = systems.modules.darwin or [ ];
create-system' = created-systems: system-metadata: create-system' = created-systems: system-metadata:
let let
overrides = systems.hosts.${system-metadata.name} or { }; overrides = systems.hosts.${system-metadata.name} or { };
user-modules =
if is-darwin system-metadata.target then
user-darwin-modules
else
user-nixos-modules;
user-modules-list = builtins.attrValues user-modules;
system-modules =
if is-darwin system-metadata.target then
darwin-modules
else
nixos-modules;
in in
{ {
${system-metadata.name} = create-system (overrides // system-metadata // { ${system-metadata.name} = create-system (overrides // system-metadata // {
systems = created-systems; systems = created-systems;
modules = user-modules ++ (overrides.modules or [ ]) ++ (systems.modules or [ ]); modules = user-modules-list ++ (overrides.modules or [ ]) ++ system-modules;
inherit homes;
}); });
}; };
created-systems = fix (created-systems: created-systems = fix (created-systems:

View file

@ -1,6 +1,7 @@
{ core-inputs { core-inputs
, user-inputs , user-inputs
, snowfall-lib , snowfall-lib
, snowfall-config
}: }:
let let

View file

@ -0,0 +1,82 @@
{ pkgs, lib, options, config, inputs, ... }:
let
inherit (lib) types mkOption mkDefault foldl optionalAttrs;
cfg = config.snowfallorg;
user-names = builtins.attrNames cfg.user;
create-system-users = system-users: name:
let
user = cfg.user.${name};
in
system-users // (optionalAttrs user.create {
${name} = {
home = mkDefault user.home.path;
isHidden = mkDefault false;
};
});
in
{
options.snowfallorg = {
user = mkOption {
description = "User configuration.";
default = { };
type = types.attrsOf (types.submodule ({ name, ... }: {
options = {
create = mkOption {
description = "Whether to create the user automatically.";
type = types.bool;
default = true;
};
home = {
enable = mkOption {
type = types.bool;
default = true;
};
path = mkOption {
type = types.str;
default = "/Users/${name}";
};
config = mkOption {
# HM-compatible options taken from:
# https://github.com/nix-community/home-manager/blob/0ee5ab611dc1fbb5180bd7d88d2aeb7841a4d179/nixos/common.nix#L14
type = types.submoduleWith {
specialArgs = {
osConfig = config;
modulesPath = "${inputs.home-manager}/modules";
} // config.home-manager.extraSpecialArgs;
modules = [
({ lib, modulesPath, ... }: {
imports = import "${modulesPath}/modules.nix" {
inherit pkgs lib;
useNixpkgsModule = !config.home-manager.useGlobalPkgs;
};
config = {
submoduleSupport.enable = true;
submoduleSupport.externalPackageInstall = cfg.useUserPackages;
home.username = config.users.users.${name}.name;
home.homeDirectory = config.users.users.${name}.home;
nix.package = config.nix.package;
};
})
] ++ config.home-manager.sharedModules;
};
};
};
};
}));
};
};
config = {
users.users = (foldl create-system-users { } (user-names));
};
}

View file

@ -0,0 +1,52 @@
inputs@{ pkgs, lib, options, config, ... }:
let
inherit (lib) types mkOption mkIf mkDefault;
cfg = config.snowfallorg;
# @NOTE(jakehamilton): The module system chokes if it finds `osConfig` named in the module arguments
# when being used in standalone home-manager. To remedy this, we have to refer to the arguments set directly.
os-user-home = inputs.osConfig.users.users.${cfg.name}.home or null;
has-user-name = (cfg.user.name or null) != null;
default-home-directory =
if (os-user-home != null) then
os-user-home
else if pkgs.stdenv.isDarwin then
"/Users/${cfg.user.name}"
else
"/home/${cfg.user.name}";
in
{
options.snowfallorg = {
user = {
enable = mkOption {
type = types.bool;
default = false;
description = "Whether to configure the user.";
};
name = mkOption {
type = types.str;
description = "The user's name.";
};
home = {
directory = mkOption {
type = types.str;
description = "The user's home directory.";
default = default-home-directory;
};
};
};
};
config = mkIf cfg.user.enable {
home = {
username = mkIf has-user-name (mkDefault cfg.user.name);
homeDirectory = mkIf has-user-name (mkDefault cfg.user.home.directory);
};
};
}

View file

@ -0,0 +1,95 @@
{ pkgs, lib, options, config, inputs, ... }:
let
inherit (lib) types mkOption mkDefault foldl optionalAttrs optional;
cfg = config.snowfallorg;
user-names = builtins.attrNames cfg.user;
create-system-users = system-users: name:
let
user = cfg.user.${name};
in
system-users // (optionalAttrs user.create {
${name} = {
isNormalUser = mkDefault true;
name = mkDefault name;
home = mkDefault user.home.path;
group = mkDefault "users";
extraGroups = optional user.admin "wheel";
};
});
in
{
options.snowfallorg = {
user = mkOption {
description = "User configuration.";
default = { };
type = types.attrsOf (types.submodule ({ name, ... }: {
options = {
create = mkOption {
description = "Whether to create the user automatically.";
type = types.bool;
default = true;
};
admin = mkOption {
description = "Whether the user should be added to the wheel group.";
type = types.bool;
default = true;
};
home = {
enable = mkOption {
type = types.bool;
default = true;
};
path = mkOption {
type = types.str;
default = "/home/${name}";
};
config = mkOption {
# HM-compatible options taken from:
# https://github.com/nix-community/home-manager/blob/0ee5ab611dc1fbb5180bd7d88d2aeb7841a4d179/nixos/common.nix#L14
type = types.submoduleWith {
specialArgs = {
osConfig = config;
modulesPath = "${inputs.home-manager}/modules";
} // config.home-manager.extraSpecialArgs;
modules = [
({ lib, modulesPath, ... }: {
imports = import "${modulesPath}/modules.nix" {
inherit pkgs lib;
useNixpkgsModule = !config.home-manager.useGlobalPkgs;
};
config = {
submoduleSupport.enable = true;
submoduleSupport.externalPackageInstall = cfg.useUserPackages;
home.username = config.users.users.${name}.name;
home.homeDirectory = config.users.users.${name}.home;
nix.package = config.nix.package;
};
})
] ++ config.home-manager.sharedModules;
};
};
};
};
}));
};
};
config = {
users.users = (foldl (create-system-users) { } (user-names));
};
}