feat: convert comments to doc comments
This commit is contained in:
Jake Hamilton
parent
116971f60d
commit
838d233474
13 changed files with 559 additions and 226 deletions
|
|
@ -52,6 +52,7 @@
|
|||
};
|
||||
|
||||
_snowfall = rec {
|
||||
|
||||
raw-config = config;
|
||||
|
||||
config = {
|
||||
|
|
@ -59,6 +60,11 @@
|
|||
src = ./.;
|
||||
namespace = "snowfall";
|
||||
lib-dir = "snowfall-lib";
|
||||
|
||||
meta = {
|
||||
name = "snowfall-lib";
|
||||
title = "Snowfall Lib";
|
||||
};
|
||||
};
|
||||
|
||||
internal-lib =
|
||||
|
|
|
|||
|
|
@ -17,29 +17,53 @@ let
|
|||
in
|
||||
{
|
||||
attrs = {
|
||||
# Map and flatten an attribute set into a list.
|
||||
# Type: (a -> b -> [c]) -> Attrs -> [c]
|
||||
# Usage: map-concat-attrs-to-list (name: value: [name value]) { x = 1; y = 2; }
|
||||
# result: [ "x" 1 "y" 2 ]
|
||||
## Map and flatten an attribute set into a list.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## map-concat-attrs-to-list (name: value: [name value]) { x = 1; y = 2; }
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## [ "x" 1 "y" 2 ]
|
||||
## ```
|
||||
#@ (a -> b -> [c]) -> Attrs -> [c]
|
||||
map-concat-attrs-to-list = f: attrs:
|
||||
flatten (mapAttrsToList f attrs);
|
||||
|
||||
# Recursively merge a list of attribute sets.
|
||||
# Type: [Attrs] -> Attrs
|
||||
# Usage: merge-deep [{ x = 1; } { x = 2; }]
|
||||
# result: { x = 2; }
|
||||
## Recursively merge a list of attribute sets.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## merge-deep [{ x = 1; } { x = 2; }]
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## { x = 2; }
|
||||
## ```
|
||||
#@ [Attrs] -> Attrs
|
||||
merge-deep = foldl recursiveUpdate { };
|
||||
|
||||
# Merge the root of a list of attribute sets.
|
||||
# Type: [Attrs] -> Attrs
|
||||
# Usage: merge-shallow [{ x = 1; } { x = 2; }]
|
||||
# result: { x = 2; }
|
||||
## Merge the root of a list of attribute sets.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## merge-shallow [{ x = 1; } { x = 2; }]
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## { x = 2; }
|
||||
## ```
|
||||
#@ [Attrs] -> Attrs
|
||||
merge-shallow = foldl mergeAttrs { };
|
||||
|
||||
# Merge shallow for packages, but allow one deeper layer of attribute sets.
|
||||
# Type: [Attrs] -> Attrs
|
||||
# Usage: merge-shallow-packages [ { inherit (pkgs) vim; some.value = true; } { some.value = false; } ]
|
||||
# result: { vim = ...; some.value = false; }
|
||||
## Merge shallow for packages, but allow one deeper layer of attribute sets.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## merge-shallow-packages [ { inherit (pkgs) vim; some.value = true; } { some.value = false; } ]
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## { vim = ...; some.value = false; }
|
||||
## ```
|
||||
#@ [Attrs] -> Attrs
|
||||
merge-shallow-packages = items:
|
||||
foldl
|
||||
(result: item:
|
||||
|
|
|
|||
|
|
@ -9,29 +9,52 @@ let
|
|||
in
|
||||
rec {
|
||||
flake = rec {
|
||||
# Remove the `self` attribute from an attribute set.
|
||||
# Type: Attrs -> Attrs
|
||||
# Usage: without-self { self = {}; x = true; }
|
||||
# result: { x = true; }
|
||||
## Remove the `self` attribute from an attribute set.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## without-self { self = {}; x = true; }
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## { x = true; }
|
||||
## ```
|
||||
#@ Attrs -> Attrs
|
||||
without-self = flake-inputs: builtins.removeAttrs flake-inputs [ "self" ];
|
||||
|
||||
# Remove the `src` attribute from an attribute set.
|
||||
# Type: Attrs -> Attrs
|
||||
# Usage: without-src { src = ./.; x = true; }
|
||||
# result: { x = true; }
|
||||
## Remove the `src` attribute from an attribute set.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## without-src { src = ./.; x = true; }
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## { x = true; }
|
||||
## ```
|
||||
#@ Attrs -> Attrs
|
||||
without-src = flake-inputs: builtins.removeAttrs flake-inputs [ "src" ];
|
||||
|
||||
# Remove the `src` and `self` attributes from an attribute set.
|
||||
# Type: Attrs -> Attrs
|
||||
# Usage: without-snowfall-inputs { self = {}; src = ./.; x = true; }
|
||||
# result: { x = true; }
|
||||
## Remove the `src` and `self` attributes from an attribute set.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## without-snowfall-inputs { self = {}; src = ./.; x = true; }
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## { x = true; }
|
||||
## ```
|
||||
#@ Attrs -> Attrs
|
||||
without-snowfall-inputs = snowfall-lib.fp.compose without-self without-src;
|
||||
|
||||
# Remove Snowfall-specific attributes so the rest can be safely
|
||||
# passed to flake-utils-plus.
|
||||
# Type: Attrs -> Attrs
|
||||
# Usage: without-snowfall-options { src = ./.; x = true; }
|
||||
# result: { x = true; }
|
||||
## Remove Snowfall-specific attributes so the rest can be safely passed to flake-utils-plus.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## without-snowfall-options { src = ./.; x = true; }
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## { x = true; }
|
||||
## ```
|
||||
#@ Attrs -> Attrs
|
||||
without-snowfall-options = flake-options:
|
||||
builtins.removeAttrs
|
||||
flake-options
|
||||
|
|
@ -51,12 +74,16 @@ rec {
|
|||
"snowfall"
|
||||
];
|
||||
|
||||
# Transform an attribute set of inputs into an attribute set where
|
||||
# the values are the inputs' `lib` attribute. Entries without a `lib`
|
||||
# attribute are removed.
|
||||
# Type: Attrs -> Attrs
|
||||
# Usage: get-lib { x = nixpkgs; y = {}; }
|
||||
# result: { x = nixpkgs.lib; }
|
||||
## Transform an attribute set of inputs into an attribute set where the values are the inputs' `lib` attribute. Entries without a `lib` attribute are removed.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-lib { x = nixpkgs; y = {}; }
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## { x = nixpkgs.lib; }
|
||||
## ```
|
||||
#@ Attrs -> Attrs
|
||||
get-libs = attrs:
|
||||
let
|
||||
# @PERF(jakehamilton): Replace filter+map with a fold.
|
||||
|
|
|
|||
|
|
@ -10,28 +10,52 @@ let
|
|||
in
|
||||
{
|
||||
fp = rec {
|
||||
# Compose two functions.
|
||||
# Type: (b -> c) -> (a -> b) -> a -> c
|
||||
# Usage: compose add-two add-one
|
||||
# result: (x: add-two (add-one x))
|
||||
## Compose two functions.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## compose add-two add-one
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## (x: add-two (add-one x))
|
||||
## ```
|
||||
#@ (b -> c) -> (a -> b) -> a -> c
|
||||
compose = f: g: x: f (g x);
|
||||
|
||||
# Compose many functions.
|
||||
# Type: [(x -> y)] -> a -> b
|
||||
# Usage: compose-all [ add-two add-one ]
|
||||
# result: (x: add-two (add-one x))
|
||||
## Compose many functions.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## compose-all [ add-two add-one ]
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## (x: add-two (add-one x))
|
||||
## ```
|
||||
#@ [(x -> y)] -> a -> b
|
||||
compose-all = foldr compose id;
|
||||
|
||||
# Call a function with an argument.
|
||||
# Type: (a -> b) -> a -> b
|
||||
# Usage: call (x: x + 1) 0
|
||||
# result: 1
|
||||
## Call a function with an argument.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## call (x: x + 1) 0
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## 1
|
||||
## ```
|
||||
#@ (a -> b) -> a -> b
|
||||
call = f: x: f x;
|
||||
|
||||
# Apply an argument to a function.
|
||||
# Type: a -> (a -> b) -> b
|
||||
# Usage: call (x: x + 1) 0
|
||||
# result: 1
|
||||
## Apply an argument to a function.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## call (x: x + 1) 0
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## 1
|
||||
## ```
|
||||
#@ a -> (a -> b) -> b
|
||||
apply = flip call;
|
||||
};
|
||||
}
|
||||
|
|
|
|||
|
|
@ -13,47 +13,83 @@ let
|
|||
in
|
||||
{
|
||||
fs = rec {
|
||||
# Matchers for file kinds. These are often used with `readDir`.
|
||||
# Type: String -> Bool
|
||||
# Usage: is-file-kind "directory"
|
||||
# result: false
|
||||
## Matchers for file kinds. These are often used with `readDir`.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## is-file-kind "directory"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## false
|
||||
## ```
|
||||
#@ String -> Bool
|
||||
is-file-kind = kind: kind == "regular";
|
||||
is-symlink-kind = kind: kind == "symlink";
|
||||
is-directory-kind = kind: kind == "directory";
|
||||
is-unknown-kind = kind: kind == "unknown";
|
||||
|
||||
# Get a file path relative to the user's flake.
|
||||
# Type: Path -> Path
|
||||
# Usage: get-file "systems"
|
||||
# result: "/user-source/systems"
|
||||
## Get a file path relative to the user's flake.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-file "systems"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## "/user-source/systems"
|
||||
## ```
|
||||
#@ Path -> Path
|
||||
get-file = path: "${user-inputs.src}/${path}";
|
||||
|
||||
# Get a file path relative to the user's snowfall directory.
|
||||
# Type: Path -> Path
|
||||
# Usage: get-snowfall-file "systems"
|
||||
# result: "/user-source/snowfall-dir/systems"
|
||||
## Get a file path relative to the user's snowfall directory.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-snowfall-file "systems"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## "/user-source/snowfall-dir/systems"
|
||||
## ```
|
||||
#@ Path -> Path
|
||||
get-snowfall-file = path: "${snowfall-config.root}/${path}";
|
||||
|
||||
# Get a file path relative to the this flake.
|
||||
# Type: Path -> Path
|
||||
# Usage: get-file "systems"
|
||||
# result: "/user-source/systems"
|
||||
## Get a file path relative to the this flake.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-file "systems"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## "/user-source/systems"
|
||||
## ```
|
||||
#@ Path -> Path
|
||||
internal-get-file = path: "${core-inputs.src}/${path}";
|
||||
|
||||
# Safely read from a directory if it exists.
|
||||
# Type: Path -> Attrs
|
||||
# Usage: safe-read-directory ./some/path
|
||||
# result: { "my-file.txt" = "regular"; }
|
||||
## Safely read from a directory if it exists.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## safe-read-directory ./some/path
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## { "my-file.txt" = "regular"; }
|
||||
## ```
|
||||
#@ Path -> Attrs
|
||||
safe-read-directory = path:
|
||||
if pathExists path then
|
||||
readDir path
|
||||
else
|
||||
{ };
|
||||
|
||||
# Get directories at a given path.
|
||||
# Type: Path -> [Path]
|
||||
# Usage: get-directories ./something
|
||||
# result: [ "./something/a-directory" ]
|
||||
## Get directories at a given path.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-directories ./something
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## [ "./something/a-directory" ]
|
||||
## ```
|
||||
#@ Path -> [Path]
|
||||
get-directories = path:
|
||||
let
|
||||
entries = safe-read-directory path;
|
||||
|
|
@ -61,10 +97,16 @@ in
|
|||
in
|
||||
mapAttrsToList (name: kind: "${path}/${name}") filtered-entries;
|
||||
|
||||
# Get files at a given path.
|
||||
# Type: Path -> [Path]
|
||||
# Usage: get-files ./something
|
||||
# result: [ "./something/a-file" ]
|
||||
## Get files at a given path.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-files ./something
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## [ "./something/a-file" ]
|
||||
## ```
|
||||
#@ Path -> [Path]
|
||||
get-files = path:
|
||||
let
|
||||
entries = safe-read-directory path;
|
||||
|
|
@ -72,10 +114,16 @@ in
|
|||
in
|
||||
mapAttrsToList (name: kind: "${path}/${name}") filtered-entries;
|
||||
|
||||
# Get files at a given path, traversing any directories within.
|
||||
# Type: Path -> [Path]
|
||||
# Usage: get-files-recursive ./something
|
||||
# result: [ "./something/some-directory/a-file" ]
|
||||
## Get files at a given path, traversing any directories within.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-files-recursive ./something
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## [ "./something/some-directory/a-file" ]
|
||||
## ```
|
||||
#@ Path -> [Path]
|
||||
get-files-recursive = path:
|
||||
let
|
||||
entries = safe-read-directory path;
|
||||
|
|
@ -97,46 +145,76 @@ in
|
|||
in
|
||||
files;
|
||||
|
||||
# Get nix files at a given path.
|
||||
# Type: Path -> [Path]
|
||||
# Usage: get-nix-files "./something"
|
||||
# result: [ "./something/a.nix" ]
|
||||
## Get nix files at a given path.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-nix-files "./something"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## [ "./something/a.nix" ]
|
||||
## ```
|
||||
#@ Path -> [Path]
|
||||
get-nix-files = path:
|
||||
builtins.filter
|
||||
(snowfall-lib.path.has-file-extension "nix")
|
||||
(get-files path);
|
||||
|
||||
# Get nix files at a given path, traversing any directories within.
|
||||
# Type: Path -> [Path]
|
||||
# Usage: get-nix-files "./something"
|
||||
# result: [ "./something/a.nix" ]
|
||||
## Get nix files at a given path, traversing any directories within.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-nix-files "./something"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## [ "./something/a.nix" ]
|
||||
## ```
|
||||
#@ Path -> [Path]
|
||||
get-nix-files-recursive = path:
|
||||
builtins.filter
|
||||
(snowfall-lib.path.has-file-extension "nix")
|
||||
(get-files-recursive path);
|
||||
|
||||
# Get nix files at a given path named "default.nix".
|
||||
# Type: Path -> [Path]
|
||||
# Usage: get-default-nix-files "./something"
|
||||
# result: [ "./something/default.nix" ]
|
||||
## Get nix files at a given path named "default.nix".
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-default-nix-files "./something"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## [ "./something/default.nix" ]
|
||||
## ```
|
||||
#@ Path -> [Path]
|
||||
get-default-nix-files = path:
|
||||
builtins.filter
|
||||
(name: builtins.baseNameOf name == "default.nix")
|
||||
(get-files path);
|
||||
|
||||
# Get nix files at a given path named "default.nix", traversing any directories within.
|
||||
# Type: Path -> [Path]
|
||||
# Usage: get-default-nix-files-recursive "./something"
|
||||
# result: [ "./something/some-directory/default.nix" ]
|
||||
## Get nix files at a given path named "default.nix", traversing any directories within.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-default-nix-files-recursive "./something"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## [ "./something/some-directory/default.nix" ]
|
||||
## ```
|
||||
#@ Path -> [Path]
|
||||
get-default-nix-files-recursive = path:
|
||||
builtins.filter
|
||||
(name: builtins.baseNameOf name == "default.nix")
|
||||
(get-files-recursive path);
|
||||
|
||||
# Get nix files at a given path not named "default.nix".
|
||||
# Type: Path -> [Path]
|
||||
# Usage: get-non-default-nix-files "./something"
|
||||
# result: [ "./something/a.nix" ]
|
||||
## Get nix files at a given path not named "default.nix".
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-non-default-nix-files "./something"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## [ "./something/a.nix" ]
|
||||
## ```
|
||||
#@ Path -> [Path]
|
||||
get-non-default-nix-files = path:
|
||||
builtins.filter
|
||||
(name:
|
||||
|
|
@ -145,11 +223,16 @@ in
|
|||
)
|
||||
(get-files path);
|
||||
|
||||
# Get nix files at a given path not named "default.nix",
|
||||
# traversing any directories within.
|
||||
# Type: Path -> [Path]
|
||||
# Usage: get-non-default-nix-files-recursive "./something"
|
||||
# result: [ "./something/some-directory/a.nix" ]
|
||||
## Get nix files at a given path not named "default.nix", traversing any directories within.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-non-default-nix-files-recursive "./something"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## [ "./something/some-directory/a.nix" ]
|
||||
## ```
|
||||
#@ Path -> [Path]
|
||||
get-non-default-nix-files-recursive = path:
|
||||
builtins.filter
|
||||
(name:
|
||||
|
|
|
|||
|
|
@ -47,10 +47,16 @@ in
|
|||
else
|
||||
{ };
|
||||
|
||||
# Get the user and host from a combined string.
|
||||
# Type: String -> Attrs
|
||||
# Usage: split-user-and-host "myuser@myhost"
|
||||
# result: { user = "myuser"; host = "myhost"; }
|
||||
## Get the user and host from a combined string.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## split-user-and-host "myuser@myhost"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## { user = "myuser"; host = "myhost"; }
|
||||
## ```
|
||||
#@ String -> Attrs
|
||||
split-user-and-host = target:
|
||||
let
|
||||
raw-name-parts = builtins.split "@" target;
|
||||
|
|
@ -68,10 +74,16 @@ in
|
|||
};
|
||||
|
||||
|
||||
# Create a home.
|
||||
# Type: Attrs -> Attrs
|
||||
# Usage: create-home { path = ./homes/my-home; }
|
||||
# result: <flake-utils-plus-home-configuration>
|
||||
## Create a home.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## create-home { path = ./homes/my-home; }
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## <flake-utils-plus-home-configuration>
|
||||
## ```
|
||||
#@ Attrs -> Attrs
|
||||
create-home =
|
||||
{ path
|
||||
, name ? builtins.unsafeDiscardStringContext (snowfall-lib.system.get-inferred-system-name path)
|
||||
|
|
@ -129,10 +141,16 @@ in
|
|||
});
|
||||
};
|
||||
|
||||
# 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 structured data about all homes for a given target.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-target-homes-metadata ./homes
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## [ { system = "x86_64-linux"; name = "my-home"; path = "/homes/x86_64-linux/my-home";} ]
|
||||
## ```
|
||||
#@ String -> [Attrs]
|
||||
get-target-homes-metadata = target:
|
||||
let
|
||||
homes = snowfall-lib.fs.get-directories target;
|
||||
|
|
@ -152,10 +170,16 @@ in
|
|||
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 all available homes.
|
||||
## Example 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>; }
|
||||
## ```
|
||||
#@ Attrs -> Attrs
|
||||
create-homes = homes:
|
||||
let
|
||||
targets = snowfall-lib.fs.get-directories user-homes-root;
|
||||
|
|
@ -186,10 +210,16 @@ in
|
|||
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 system modules for home-manager integration.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## create-home-system-modules { users."my-user@my-system".specialArgs.x = true; modules = [ my-shared-module ]; }
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## [Module]
|
||||
## ```
|
||||
#@ Attrs -> [Module]
|
||||
create-home-system-modules = users:
|
||||
let
|
||||
created-users = create-homes users;
|
||||
|
|
|
|||
|
|
@ -12,10 +12,16 @@ let
|
|||
in
|
||||
{
|
||||
module = {
|
||||
# Create flake output modules.
|
||||
# Type: Attrs -> Attrs
|
||||
# Usage: create-modules { src = ./my-modules; overrides = { inherit another-module; }; alias = { default = "another-module" }; }
|
||||
# result: { another-module = ...; my-module = ...; default = ...; }
|
||||
## Create flake output modules.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## create-modules { src = ./my-modules; overrides = { inherit another-module; }; alias = { default = "another-module" }; }
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## { another-module = ...; my-module = ...; default = ...; }
|
||||
## ```
|
||||
#@ Attrs -> Attrs
|
||||
create-modules =
|
||||
{ src ? "${user-modules-root}/nixos"
|
||||
, overrides ? { }
|
||||
|
|
|
|||
|
|
@ -12,10 +12,16 @@ let
|
|||
in
|
||||
{
|
||||
overlay = {
|
||||
# Create a flake-utils-plus overlays builder.
|
||||
# Type: Attrs -> Attrs -> [(a -> b -> c)]
|
||||
# Usage: create-overlays { src = ./my-overlays; package-namespace = "my-packages"; }
|
||||
# result: (channels: [ ... ])
|
||||
## Create a flake-utils-plus overlays builder.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## create-overlays { src = ./my-overlays; package-namespace = "my-packages"; }
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## (channels: [ ... ])
|
||||
## ```
|
||||
#@ Attrs -> Attrs -> [(a -> b -> c)]
|
||||
create-overlays-builder =
|
||||
{ src ? user-overlays-root
|
||||
, package-namespace ? "internal"
|
||||
|
|
@ -41,12 +47,17 @@ in
|
|||
in
|
||||
overlays;
|
||||
|
||||
# Create exported overlays from the user flake.
|
||||
# Adapted from flake-utils-plus:
|
||||
# https://github.com/gytis-ivaskevicius/flake-utils-plus/blob/2bf0f91643c2e5ae38c1b26893ac2927ac9bd82a/lib/exportOverlays.nix
|
||||
# Type: Attrs -> Attrs
|
||||
# Usage: create-overlays { src = ./my-overlays; packages-src = ./my-packages; package-namespace = "my-namespace"; extra-overlays = {}; }
|
||||
# result: { default = final: prev: ...; some-overlay = final: prev: ...; }
|
||||
## Create exported overlays from the user flake. Adapted [from flake-utils-plus](https://github.com/gytis-ivaskevicius/flake-utils-plus/blob/2bf0f91643c2e5ae38c1b26893ac2927ac9bd82a/lib/exportOverlays.nix).
|
||||
##
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## create-overlays { src = ./my-overlays; packages-src = ./my-packages; package-namespace = "my-namespace"; extra-overlays = {}; }
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## { default = final: prev: ...; some-overlay = final: prev: ...; }
|
||||
## ```
|
||||
#@ Attrs -> Attrs
|
||||
create-overlays =
|
||||
{ src ? user-overlays-root
|
||||
, packages-src ? user-packages-root
|
||||
|
|
|
|||
|
|
@ -12,10 +12,16 @@ let
|
|||
in
|
||||
{
|
||||
package = rec {
|
||||
# Create flake output packages.
|
||||
# Type: Attrs -> Attrs
|
||||
# Usage: create-packages { inherit channels; src = ./my-packages; overrides = { inherit another-package; }; alias.default = "another-package"; }
|
||||
# result: { another-package = ...; my-package = ...; default = ...; }
|
||||
## Create flake output packages.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## create-packages { inherit channels; src = ./my-packages; overrides = { inherit another-package; }; alias.default = "another-package"; }
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## { another-package = ...; my-package = ...; default = ...; }
|
||||
## ```
|
||||
#@ Attrs -> Attrs
|
||||
create-packages =
|
||||
{ channels
|
||||
, src ? user-packages-root
|
||||
|
|
|
|||
|
|
@ -12,10 +12,16 @@ let
|
|||
in
|
||||
{
|
||||
path = rec {
|
||||
# Split a file name and its extension.
|
||||
# Type: String -> [String]
|
||||
# Usage: split-file-extension "my-file.md"
|
||||
# result: [ "my-file" "md" ]
|
||||
## Split a file name and its extension.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## split-file-extension "my-file.md"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## [ "my-file" "md" ]
|
||||
## ```
|
||||
#@ String -> [String]
|
||||
split-file-extension = file:
|
||||
let
|
||||
match = builtins.match file-name-regex file;
|
||||
|
|
@ -23,20 +29,32 @@ in
|
|||
assert assertMsg (match != null) "lib.snowfall.split-file-extension: File must have an extension to split.";
|
||||
match;
|
||||
|
||||
# Check if a file name has a file extension.
|
||||
# Type: String -> Bool
|
||||
# Usage: has-any-file-extension "my-file.txt"
|
||||
# result: true
|
||||
## Check if a file name has a file extension.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## has-any-file-extension "my-file.txt"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## true
|
||||
## ```
|
||||
#@ String -> Bool
|
||||
has-any-file-extension = file:
|
||||
let
|
||||
match = builtins.match file-name-regex (toString file);
|
||||
in
|
||||
match != null;
|
||||
|
||||
# Get the file extension of a file name.
|
||||
# Type: String -> String
|
||||
# Usage: get-file-extension "my-file.final.txt"
|
||||
# result: "txt"
|
||||
## Get the file extension of a file name.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-file-extension "my-file.final.txt"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## "txt"
|
||||
## ```
|
||||
#@ String -> String
|
||||
get-file-extension = file:
|
||||
if has-any-file-extension file then
|
||||
let
|
||||
|
|
@ -46,26 +64,44 @@ in
|
|||
else
|
||||
"";
|
||||
|
||||
# Check if a file name has a specific file extension.
|
||||
# Type: String -> String -> Bool
|
||||
# Usage: has-file-extension "txt" "my-file.txt"
|
||||
# result: true
|
||||
## Check if a file name has a specific file extension.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## has-file-extension "txt" "my-file.txt"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## true
|
||||
## ```
|
||||
#@ String -> String -> Bool
|
||||
has-file-extension = extension: file:
|
||||
if has-any-file-extension file then
|
||||
extension == get-file-extension file
|
||||
else
|
||||
false;
|
||||
|
||||
# Get the parent directory for a given path.
|
||||
# Type: Path -> Path
|
||||
# Usage: get-parent-directory "/a/b/c"
|
||||
# result: "/a/b"
|
||||
## Get the parent directory for a given path.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-parent-directory "/a/b/c"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## "/a/b"
|
||||
## ```
|
||||
#@ Path -> Path
|
||||
get-parent-directory = snowfall-lib.fp.compose baseNameOf dirOf;
|
||||
|
||||
# Get the file name of a path without its extension.
|
||||
# Type: Path -> String
|
||||
# Usage: get-file-name-without-extension ./some-directory/my-file.pdf
|
||||
# result: "my-file"
|
||||
## Get the file name of a path without its extension.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-file-name-without-extension ./some-directory/my-file.pdf
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## "my-file"
|
||||
## ```
|
||||
#@ Path -> String
|
||||
get-file-name-without-extension = path:
|
||||
let
|
||||
file-name = baseNameOf path;
|
||||
|
|
|
|||
|
|
@ -12,10 +12,16 @@ let
|
|||
in
|
||||
{
|
||||
shell = {
|
||||
# Create flake output packages.
|
||||
# Type: Attrs -> Attrs
|
||||
# Usage: create-shells { inherit channels; src = ./my-shells; overrides = { inherit another-shell; }; alias = { default = "another-shell"; }; }
|
||||
# result: { another-shell = ...; my-shell = ...; default = ...; }
|
||||
## Create flake output packages.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## create-shells { inherit channels; src = ./my-shells; overrides = { inherit another-shell; }; alias = { default = "another-shell"; }; }
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## { another-shell = ...; my-shell = ...; default = ...; }
|
||||
## ```
|
||||
#@ Attrs -> Attrs
|
||||
create-shells =
|
||||
{ channels
|
||||
, src ? user-shells-root
|
||||
|
|
|
|||
|
|
@ -15,39 +15,69 @@ let
|
|||
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 the name of a system based on its file path.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-inferred-system-name "/systems/my-system/default.nix"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## "my-system"
|
||||
## ```
|
||||
#@ Path -> String
|
||||
get-inferred-system-name = path:
|
||||
if snowfall-lib.path.has-file-extension "nix" path then
|
||||
snowfall-lib.path.get-parent-directory path
|
||||
else
|
||||
baseNameOf path;
|
||||
|
||||
# Check whether a named system is macOS.
|
||||
# Type: String -> Bool
|
||||
# Usage: is-darwin "x86_64-linux"
|
||||
# result: false
|
||||
## Check whether a named system is macOS.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## is-darwin "x86_64-linux"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## false
|
||||
## ```
|
||||
#@ String -> Bool
|
||||
is-darwin = hasInfix "darwin";
|
||||
|
||||
# Check whether a named system is Linux.
|
||||
# Type: String -> Bool
|
||||
# Usage: is-linux "x86_64-linux"
|
||||
# result: false
|
||||
## Check whether a named system is Linux.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## is-linux "x86_64-linux"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## false
|
||||
## ```
|
||||
#@ String -> Bool
|
||||
is-linux = hasInfix "linux";
|
||||
|
||||
# Check whether a named system is virtual.
|
||||
# Type: String -> Bool
|
||||
# Usage: is-virtual "x86_64-iso"
|
||||
# result: true
|
||||
## Check whether a named system is virtual.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## is-virtual "x86_64-iso"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## true
|
||||
## ```
|
||||
#@ String -> Bool
|
||||
is-virtual = target:
|
||||
(get-virtual-system-type target) != "";
|
||||
|
||||
# Get the virtual system type of a system target.
|
||||
# Type: String -> String
|
||||
# Usage: get-virtual-system-type "x86_64-iso"
|
||||
# result: "iso"
|
||||
## Get the virtual system type of a system target.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-virtual-system-type "x86_64-iso"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## "iso"
|
||||
## ```
|
||||
#@ String -> String
|
||||
get-virtual-system-type = target:
|
||||
foldl
|
||||
(result: virtual-system:
|
||||
|
|
@ -59,10 +89,16 @@ in
|
|||
""
|
||||
virtual-systems;
|
||||
|
||||
# Get structured data about all systems for a given target.
|
||||
# Type: String -> [Attrs]
|
||||
# Usage: get-target-systems-metadata "x86_64-linux"
|
||||
# result: [ { target = "x86_64-linux"; name = "my-machine"; path = "/systems/x86_64-linux/my-machine"; } ]
|
||||
## Get structured data about all systems for a given target.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-target-systems-metadata "x86_64-linux"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## [ { target = "x86_64-linux"; name = "my-machine"; path = "/systems/x86_64-linux/my-machine"; } ]
|
||||
## ```
|
||||
#@ String -> [Attrs]
|
||||
get-target-systems-metadata = target:
|
||||
let
|
||||
systems = snowfall-lib.fs.get-directories target;
|
||||
|
|
@ -82,10 +118,16 @@ in
|
|||
in
|
||||
system-configurations;
|
||||
|
||||
# Get the system builder for a given target.
|
||||
# Type: String -> Function
|
||||
# Usage: get-system-builder "x86_64-iso"
|
||||
# result: (args: <system>)
|
||||
## Get the system builder for a given target.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-system-builder "x86_64-iso"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## (args: <system>)
|
||||
## ```
|
||||
#@ String -> Function
|
||||
get-system-builder = target:
|
||||
let
|
||||
virtual-system-type = get-virtual-system-type target;
|
||||
|
|
@ -130,10 +172,16 @@ in
|
|||
else
|
||||
linux-system-builder;
|
||||
|
||||
# Get the flake output attribute for a system target.
|
||||
# Type: String -> String
|
||||
# Usage: get-system-output "aarch64-darwin"
|
||||
# result: "darwinConfigurations"
|
||||
## Get the flake output attribute for a system target.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-system-output "aarch64-darwin"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## "darwinConfigurations"
|
||||
## ```
|
||||
#@ String -> String
|
||||
get-system-output = target:
|
||||
let
|
||||
virtual-system-type = get-virtual-system-type target;
|
||||
|
|
@ -145,10 +193,16 @@ in
|
|||
else
|
||||
"nixosConfigurations";
|
||||
|
||||
# Get the resolved (non-virtual) system target.
|
||||
# Type: String -> String
|
||||
# Usage: get-resolved-system-target "x86_64-iso"
|
||||
# result: "x86_64-linux"
|
||||
## Get the resolved (non-virtual) system target.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## get-resolved-system-target "x86_64-iso"
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## "x86_64-linux"
|
||||
## ```
|
||||
#@ String -> String
|
||||
get-resolved-system-target = target:
|
||||
let
|
||||
virtual-system-type = get-virtual-system-type target;
|
||||
|
|
@ -158,10 +212,16 @@ in
|
|||
else
|
||||
target;
|
||||
|
||||
# Create a system.
|
||||
# Type: Attrs -> Attrs
|
||||
# Usage: create-system { path = ./systems/my-system; }
|
||||
# result: <flake-utils-plus-system-configuration>
|
||||
## Create a system.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## create-system { path = ./systems/my-system; }
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## <flake-utils-plus-system-configuration>
|
||||
## ```
|
||||
#@ Attrs -> Attrs
|
||||
create-system =
|
||||
{ target ? "x86_64-linux"
|
||||
, system ? get-resolved-system-target target
|
||||
|
|
@ -199,10 +259,16 @@ in
|
|||
};
|
||||
};
|
||||
|
||||
# Create all available systems.
|
||||
# Type: Attrs -> Attrs
|
||||
# Usage: create-systems { hosts.my-host.specialArgs.x = true; modules.nixos = [ my-shared-module ]; }
|
||||
# result: { my-host = <flake-utils-plus-system-configuration>; }
|
||||
## Create all available systems.
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## create-systems { hosts.my-host.specialArgs.x = true; modules.nixos = [ my-shared-module ]; }
|
||||
## ```
|
||||
## Result:
|
||||
## ```nix
|
||||
## { my-host = <flake-utils-plus-system-configuration>; }
|
||||
## ```
|
||||
#@ Attrs -> Attrs
|
||||
create-systems = { systems ? { }, homes ? { } }:
|
||||
let
|
||||
targets = snowfall-lib.fs.get-directories user-systems-root;
|
||||
|
|
|
|||
|
|
@ -12,10 +12,18 @@ let
|
|||
in
|
||||
{
|
||||
template = {
|
||||
# Create flake templates.
|
||||
# Type: Attrs -> Attrs
|
||||
# Usage: create-templates { src = ./my-templates; overrides = { inherit another-template; }; alias = { default = "another-template"; }; }
|
||||
# result: { another-template = ...; my-template = ...; default = ...; }
|
||||
## Create flake templates.
|
||||
##
|
||||
## Example Usage:
|
||||
## ```nix
|
||||
## create-templates { src = ./my-templates; overrides = { inherit another-template; }; alias = { default = "another-template"; }; }
|
||||
## ```
|
||||
##
|
||||
## Result:
|
||||
## ```nix
|
||||
## { another-template = ...; my-template = ...; default = ...; }
|
||||
## ```
|
||||
#@ Attrs -> Attrs
|
||||
create-templates =
|
||||
{ src ? user-templates-root
|
||||
, overrides ? { }
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue