kylekrein/snowfall-lib
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat: convert comments to doc comments

Browse source
This commit is contained in:
Jake Hamilton 2023-08-17 00:24:05 -07:00
parent 116971f60d
commit 838d233474
No known key found for this signature in database
GPG key ID: 9762169A1B35EA68
13 changed files with 559 additions and 226 deletions
Download patch file Download diff file Expand all files Collapse all files

6
flake.nix
View file

@ -52,6 +52,7 @@
}; };
_snowfall = rec { _snowfall = rec {
raw-config = config; raw-config = config;
config = { config = {
@ -59,6 +60,11 @@
src = ./.; src = ./.;
namespace = "snowfall"; namespace = "snowfall";
lib-dir = "snowfall-lib"; lib-dir = "snowfall-lib";
meta = {
name = "snowfall-lib";
title = "Snowfall Lib";
};
}; };
internal-lib = internal-lib =

56
snowfall-lib/attrs/default.nix
View file

@ -17,29 +17,53 @@ let
in in
{ {
attrs = { attrs = {
# Map and flatten an attribute set into a list. ## Map and flatten an attribute set into a list.
# Type: (a -> b -> [c]) -> Attrs -> [c] ## Example Usage:
# Usage: map-concat-attrs-to-list (name: value: [name value]) { x = 1; y = 2; } ## ```nix
# result: [ "x" 1 "y" 2 ] ## 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: map-concat-attrs-to-list = f: attrs:
flatten (mapAttrsToList f attrs); flatten (mapAttrsToList f attrs);
# Recursively merge a list of attribute sets. ## Recursively merge a list of attribute sets.
# Type: [Attrs] -> Attrs ## Example Usage:
# Usage: merge-deep [{ x = 1; } { x = 2; }] ## ```nix
# result: { x = 2; } ## merge-deep [{ x = 1; } { x = 2; }]
## ```
## Result:
## ```nix
## { x = 2; }
## ```
#@ [Attrs] -> Attrs
merge-deep = foldl recursiveUpdate { }; merge-deep = foldl recursiveUpdate { };
# Merge the root of a list of attribute sets. ## Merge the root of a list of attribute sets.
# Type: [Attrs] -> Attrs ## Example Usage:
# Usage: merge-shallow [{ x = 1; } { x = 2; }] ## ```nix
# result: { x = 2; } ## merge-shallow [{ x = 1; } { x = 2; }]
## ```
## Result:
## ```nix
## { x = 2; }
## ```
#@ [Attrs] -> Attrs
merge-shallow = foldl mergeAttrs { }; merge-shallow = foldl mergeAttrs { };
# Merge shallow for packages, but allow one deeper layer of attribute sets. ## Merge shallow for packages, but allow one deeper layer of attribute sets.
# Type: [Attrs] -> Attrs ## Example Usage:
# Usage: merge-shallow-packages [ { inherit (pkgs) vim; some.value = true; } { some.value = false; } ] ## ```nix
# result: { vim = ...; some.value = false; } ## merge-shallow-packages [ { inherit (pkgs) vim; some.value = true; } { some.value = false; } ]
## ```
## Result:
## ```nix
## { vim = ...; some.value = false; }
## ```
#@ [Attrs] -> Attrs
merge-shallow-packages = items: merge-shallow-packages = items:
foldl foldl
(result: item: (result: item:

73
snowfall-lib/flake/default.nix
View file

@ -9,29 +9,52 @@ let
in in
rec { rec {
flake = rec { flake = rec {
# Remove the `self` attribute from an attribute set. ## Remove the `self` attribute from an attribute set.
# Type: Attrs -> Attrs ## Example Usage:
# Usage: without-self { self = {}; x = true; } ## ```nix
# result: { x = true; } ## without-self { self = {}; x = true; }
## ```
## Result:
## ```nix
## { x = true; }
## ```
#@ Attrs -> Attrs
without-self = flake-inputs: builtins.removeAttrs flake-inputs [ "self" ]; without-self = flake-inputs: builtins.removeAttrs flake-inputs [ "self" ];
# Remove the `src` attribute from an attribute set. ## Remove the `src` attribute from an attribute set.
# Type: Attrs -> Attrs ## Example Usage:
# Usage: without-src { src = ./.; x = true; } ## ```nix
# result: { x = true; } ## without-src { src = ./.; x = true; }
## ```
## Result:
## ```nix
## { x = true; }
## ```
#@ Attrs -> Attrs
without-src = flake-inputs: builtins.removeAttrs flake-inputs [ "src" ]; without-src = flake-inputs: builtins.removeAttrs flake-inputs [ "src" ];
# Remove the `src` and `self` attributes from an attribute set. ## Remove the `src` and `self` attributes from an attribute set.
# Type: Attrs -> Attrs ## Example Usage:
# Usage: without-snowfall-inputs { self = {}; src = ./.; x = true; } ## ```nix
# result: { x = true; } ## without-snowfall-inputs { self = {}; src = ./.; x = true; }
## ```
## Result:
## ```nix
## { x = true; }
## ```
#@ Attrs -> Attrs
without-snowfall-inputs = snowfall-lib.fp.compose without-self without-src; without-snowfall-inputs = snowfall-lib.fp.compose without-self without-src;
# Remove Snowfall-specific attributes so the rest can be safely ## Remove Snowfall-specific attributes so the rest can be safely passed to flake-utils-plus.
# passed to flake-utils-plus. ## Example Usage:
# Type: Attrs -> Attrs ## ```nix
# Usage: without-snowfall-options { src = ./.; x = true; } ## without-snowfall-options { src = ./.; x = true; }
# result: { x = true; } ## ```
## Result:
## ```nix
## { x = true; }
## ```
#@ Attrs -> Attrs
without-snowfall-options = flake-options: without-snowfall-options = flake-options:
builtins.removeAttrs builtins.removeAttrs
flake-options flake-options
@ -51,12 +74,16 @@ rec {
"snowfall" "snowfall"
]; ];
# Transform an attribute set of inputs into an attribute set where ## 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.
# the values are the inputs' `lib` attribute. Entries without a `lib` ## Example Usage:
# attribute are removed. ## ```nix
# Type: Attrs -> Attrs ## get-lib { x = nixpkgs; y = {}; }
# Usage: get-lib { x = nixpkgs; y = {}; } ## ```
# result: { x = nixpkgs.lib; } ## Result:
## ```nix
## { x = nixpkgs.lib; }
## ```
#@ Attrs -> Attrs
get-libs = attrs: get-libs = attrs:
let let
# @PERF(jakehamilton): Replace filter+map with a fold. # @PERF(jakehamilton): Replace filter+map with a fold.

56
snowfall-lib/fp/default.nix
View file

@ -10,28 +10,52 @@ let
in in
{ {
fp = rec { fp = rec {
# Compose two functions. ## Compose two functions.
# Type: (b -> c) -> (a -> b) -> a -> c ## Example Usage:
# Usage: compose add-two add-one ## ```nix
# result: (x: add-two (add-one x)) ## 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 = f: g: x: f (g x);
# Compose many functions. ## Compose many functions.
# Type: [(x -> y)] -> a -> b ## Example Usage:
# Usage: compose-all [ add-two add-one ] ## ```nix
# result: (x: add-two (add-one x)) ## compose-all [ add-two add-one ]
## ```
## Result:
## ```nix
## (x: add-two (add-one x))
## ```
#@ [(x -> y)] -> a -> b
compose-all = foldr compose id; compose-all = foldr compose id;
# Call a function with an argument. ## Call a function with an argument.
# Type: (a -> b) -> a -> b ## Example Usage:
# Usage: call (x: x + 1) 0 ## ```nix
# result: 1 ## call (x: x + 1) 0
## ```
## Result:
## ```nix
## 1
## ```
#@ (a -> b) -> a -> b
call = f: x: f x; call = f: x: f x;
# Apply an argument to a function. ## Apply an argument to a function.
# Type: a -> (a -> b) -> b ## Example Usage:
# Usage: call (x: x + 1) 0 ## ```nix
# result: 1 ## call (x: x + 1) 0
## ```
## Result:
## ```nix
## 1
## ```
#@ a -> (a -> b) -> b
apply = flip call; apply = flip call;
}; };
} }

197
snowfall-lib/fs/default.nix
View file

@ -13,47 +13,83 @@ let
in in
{ {
fs = rec { fs = rec {
# Matchers for file kinds. These are often used with `readDir`. ## Matchers for file kinds. These are often used with `readDir`.
# Type: String -> Bool ## Example Usage:
# Usage: is-file-kind "directory" ## ```nix
# result: false ## is-file-kind "directory"
## ```
## Result:
## ```nix
## false
## ```
#@ String -> Bool
is-file-kind = kind: kind == "regular"; is-file-kind = kind: kind == "regular";
is-symlink-kind = kind: kind == "symlink"; is-symlink-kind = kind: kind == "symlink";
is-directory-kind = kind: kind == "directory"; is-directory-kind = kind: kind == "directory";
is-unknown-kind = kind: kind == "unknown"; is-unknown-kind = kind: kind == "unknown";
# Get a file path relative to the user's flake. ## Get a file path relative to the user's flake.
# Type: Path -> Path ## Example Usage:
# Usage: get-file "systems" ## ```nix
# result: "/user-source/systems" ## get-file "systems"
## ```
## Result:
## ```nix
## "/user-source/systems"
## ```
#@ Path -> Path
get-file = path: "${user-inputs.src}/${path}"; get-file = path: "${user-inputs.src}/${path}";
# Get a file path relative to the user's snowfall directory. ## Get a file path relative to the user's snowfall directory.
# Type: Path -> Path ## Example Usage:
# Usage: get-snowfall-file "systems" ## ```nix
# result: "/user-source/snowfall-dir/systems" ## get-snowfall-file "systems"
## ```
## Result:
## ```nix
## "/user-source/snowfall-dir/systems"
## ```
#@ Path -> Path
get-snowfall-file = path: "${snowfall-config.root}/${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 ## Example Usage:
# Usage: get-file "systems" ## ```nix
# result: "/user-source/systems" ## get-file "systems"
## ```
## Result:
## ```nix
## "/user-source/systems"
## ```
#@ Path -> Path
internal-get-file = path: "${core-inputs.src}/${path}"; internal-get-file = path: "${core-inputs.src}/${path}";
# Safely read from a directory if it exists. ## Safely read from a directory if it exists.
# Type: Path -> Attrs ## Example Usage:
# Usage: safe-read-directory ./some/path ## ```nix
# result: { "my-file.txt" = "regular"; } ## safe-read-directory ./some/path
## ```
## Result:
## ```nix
## { "my-file.txt" = "regular"; }
## ```
#@ Path -> Attrs
safe-read-directory = path: safe-read-directory = path:
if pathExists path then if pathExists path then
readDir path readDir path
else else
{ }; { };
# Get directories at a given path. ## Get directories at a given path.
# Type: Path -> [Path] ## Example Usage:
# Usage: get-directories ./something ## ```nix
# result: [ "./something/a-directory" ] ## get-directories ./something
## ```
## Result:
## ```nix
## [ "./something/a-directory" ]
## ```
#@ Path -> [Path]
get-directories = path: get-directories = path:
let let
entries = safe-read-directory path; entries = safe-read-directory path;
@ -61,10 +97,16 @@ in
in in
mapAttrsToList (name: kind: "${path}/${name}") filtered-entries; mapAttrsToList (name: kind: "${path}/${name}") filtered-entries;
# Get files at a given path. ## Get files at a given path.
# Type: Path -> [Path] ## Example Usage:
# Usage: get-files ./something ## ```nix
# result: [ "./something/a-file" ] ## get-files ./something
## ```
## Result:
## ```nix
## [ "./something/a-file" ]
## ```
#@ Path -> [Path]
get-files = path: get-files = path:
let let
entries = safe-read-directory path; entries = safe-read-directory path;
@ -72,10 +114,16 @@ in
in in
mapAttrsToList (name: kind: "${path}/${name}") filtered-entries; mapAttrsToList (name: kind: "${path}/${name}") filtered-entries;
# Get files at a given path, traversing any directories within. ## Get files at a given path, traversing any directories within.
# Type: Path -> [Path] ## Example Usage:
# Usage: get-files-recursive ./something ## ```nix
# result: [ "./something/some-directory/a-file" ] ## get-files-recursive ./something
## ```
## Result:
## ```nix
## [ "./something/some-directory/a-file" ]
## ```
#@ Path -> [Path]
get-files-recursive = path: get-files-recursive = path:
let let
entries = safe-read-directory path; entries = safe-read-directory path;
@ -97,46 +145,76 @@ in
in in
files; files;
# Get nix files at a given path. ## Get nix files at a given path.
# Type: Path -> [Path] ## Example Usage:
# Usage: get-nix-files "./something" ## ```nix
# result: [ "./something/a.nix" ] ## get-nix-files "./something"
## ```
## Result:
## ```nix
## [ "./something/a.nix" ]
## ```
#@ Path -> [Path]
get-nix-files = path: get-nix-files = path:
builtins.filter builtins.filter
(snowfall-lib.path.has-file-extension "nix") (snowfall-lib.path.has-file-extension "nix")
(get-files path); (get-files path);
# Get nix files at a given path, traversing any directories within. ## Get nix files at a given path, traversing any directories within.
# Type: Path -> [Path] ## Example Usage:
# Usage: get-nix-files "./something" ## ```nix
# result: [ "./something/a.nix" ] ## get-nix-files "./something"
## ```
## Result:
## ```nix
## [ "./something/a.nix" ]
## ```
#@ Path -> [Path]
get-nix-files-recursive = path: get-nix-files-recursive = path:
builtins.filter builtins.filter
(snowfall-lib.path.has-file-extension "nix") (snowfall-lib.path.has-file-extension "nix")
(get-files-recursive path); (get-files-recursive path);
# Get nix files at a given path named "default.nix". ## Get nix files at a given path named "default.nix".
# Type: Path -> [Path] ## Example Usage:
# Usage: get-default-nix-files "./something" ## ```nix
# result: [ "./something/default.nix" ] ## get-default-nix-files "./something"
## ```
## Result:
## ```nix
## [ "./something/default.nix" ]
## ```
#@ Path -> [Path]
get-default-nix-files = path: get-default-nix-files = path:
builtins.filter builtins.filter
(name: builtins.baseNameOf name == "default.nix") (name: builtins.baseNameOf name == "default.nix")
(get-files path); (get-files path);
# Get nix files at a given path named "default.nix", traversing any directories within. ## Get nix files at a given path named "default.nix", traversing any directories within.
# Type: Path -> [Path] ## Example Usage:
# Usage: get-default-nix-files-recursive "./something" ## ```nix
# result: [ "./something/some-directory/default.nix" ] ## get-default-nix-files-recursive "./something"
## ```
## Result:
## ```nix
## [ "./something/some-directory/default.nix" ]
## ```
#@ Path -> [Path]
get-default-nix-files-recursive = path: get-default-nix-files-recursive = path:
builtins.filter builtins.filter
(name: builtins.baseNameOf name == "default.nix") (name: builtins.baseNameOf name == "default.nix")
(get-files-recursive path); (get-files-recursive path);
# Get nix files at a given path not named "default.nix". ## Get nix files at a given path not named "default.nix".
# Type: Path -> [Path] ## Example Usage:
# Usage: get-non-default-nix-files "./something" ## ```nix
# result: [ "./something/a.nix" ] ## get-non-default-nix-files "./something"
## ```
## Result:
## ```nix
## [ "./something/a.nix" ]
## ```
#@ Path -> [Path]
get-non-default-nix-files = path: get-non-default-nix-files = path:
builtins.filter builtins.filter
(name: (name:
@ -145,11 +223,16 @@ in
) )
(get-files path); (get-files path);
# Get nix files at a given path not named "default.nix", ## Get nix files at a given path not named "default.nix", traversing any directories within.
# traversing any directories within. ## Example Usage:
# Type: Path -> [Path] ## ```nix
# Usage: get-non-default-nix-files-recursive "./something" ## get-non-default-nix-files-recursive "./something"
# result: [ "./something/some-directory/a.nix" ] ## ```
## Result:
## ```nix
## [ "./something/some-directory/a.nix" ]
## ```
#@ Path -> [Path]
get-non-default-nix-files-recursive = path: get-non-default-nix-files-recursive = path:
builtins.filter builtins.filter
(name: (name:

70
snowfall-lib/home/default.nix
View file

@ -47,10 +47,16 @@ in
else else
{ }; { };
# Get the user and host from a combined string. ## Get the user and host from a combined string.
# Type: String -> Attrs ## Example Usage:
# Usage: split-user-and-host "myuser@myhost" ## ```nix
# result: { user = "myuser"; host = "myhost"; } ## split-user-and-host "myuser@myhost"
## ```
## Result:
## ```nix
## { user = "myuser"; host = "myhost"; }
## ```
#@ String -> Attrs
split-user-and-host = target: split-user-and-host = target:
let let
raw-name-parts = builtins.split "@" target; raw-name-parts = builtins.split "@" target;
@ -68,10 +74,16 @@ in
}; };
# Create a home. ## Create a home.
# Type: Attrs -> Attrs ## Example Usage:
# Usage: create-home { path = ./homes/my-home; } ## ```nix
# result: <flake-utils-plus-home-configuration> ## create-home { path = ./homes/my-home; }
## ```
## Result:
## ```nix
## <flake-utils-plus-home-configuration>
## ```
#@ Attrs -> Attrs
create-home = create-home =
{ path { path
, name ? builtins.unsafeDiscardStringContext (snowfall-lib.system.get-inferred-system-name 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. ## Get structured data about all homes for a given target.
# Type: String -> [Attrs] ## Example Usage:
# Usage: get-target-homes-metadata ./homes ## ```nix
# result: [ { system = "x86_64-linux"; name = "my-home"; path = "/homes/x86_64-linux/my-home";} ] ## 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: get-target-homes-metadata = target:
let let
homes = snowfall-lib.fs.get-directories target; homes = snowfall-lib.fs.get-directories target;
@ -152,10 +170,16 @@ in
in in
home-configurations; home-configurations;
# Create all available homes. ## Create all available homes.
# Type: Attrs -> Attrs ## Example Usage:
# Usage: create-homes { users."my-user@my-system".specialArgs.x = true; modules = [ my-shared-module ]; } ## ```nix
# result: { "my-user@my-system" = <flake-utils-plus-home-configuration>; } ## 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: create-homes = homes:
let let
targets = snowfall-lib.fs.get-directories user-homes-root; targets = snowfall-lib.fs.get-directories user-homes-root;
@ -186,10 +210,16 @@ in
in in
created-homes; created-homes;
# Create system modules for home-manager integration. ## Create system modules for home-manager integration.
# Type: Attrs -> [Module] ## Example Usage:
# Usage: create-home-system-modules { users."my-user@my-system".specialArgs.x = true; modules = [ my-shared-module ]; } ## ```nix
# result: [Module] ## 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: create-home-system-modules = users:
let let
created-users = create-homes users; created-users = create-homes users;

14
snowfall-lib/module/default.nix
View file

@ -12,10 +12,16 @@ let
in in
{ {
module = { module = {
# Create flake output modules. ## Create flake output modules.
# Type: Attrs -> Attrs ## Example Usage:
# Usage: create-modules { src = ./my-modules; overrides = { inherit another-module; }; alias = { default = "another-module" }; } ## ```nix
# result: { another-module = ...; my-module = ...; default = ...; } ## create-modules { src = ./my-modules; overrides = { inherit another-module; }; alias = { default = "another-module" }; }
## ```
## Result:
## ```nix
## { another-module = ...; my-module = ...; default = ...; }
## ```
#@ Attrs -> Attrs
create-modules = create-modules =
{ src ? "${user-modules-root}/nixos" { src ? "${user-modules-root}/nixos"
, overrides ? { } , overrides ? { }

31
snowfall-lib/overlay/default.nix
View file

@ -12,10 +12,16 @@ let
in in
{ {
overlay = { overlay = {
# Create a flake-utils-plus overlays builder. ## Create a flake-utils-plus overlays builder.
# Type: Attrs -> Attrs -> [(a -> b -> c)] ## Example Usage:
# Usage: create-overlays { src = ./my-overlays; package-namespace = "my-packages"; } ## ```nix
# result: (channels: [ ... ]) ## create-overlays { src = ./my-overlays; package-namespace = "my-packages"; }
## ```
## Result:
## ```nix
## (channels: [ ... ])
## ```
#@ Attrs -> Attrs -> [(a -> b -> c)]
create-overlays-builder = create-overlays-builder =
{ src ? user-overlays-root { src ? user-overlays-root
, package-namespace ? "internal" , package-namespace ? "internal"
@ -41,12 +47,17 @@ in
in in
overlays; overlays;
# Create exported overlays from the user flake. ## 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).
# Adapted from flake-utils-plus: ##
# https://github.com/gytis-ivaskevicius/flake-utils-plus/blob/2bf0f91643c2e5ae38c1b26893ac2927ac9bd82a/lib/exportOverlays.nix ## Example Usage:
# Type: Attrs -> Attrs ## ```nix
# Usage: create-overlays { src = ./my-overlays; packages-src = ./my-packages; package-namespace = "my-namespace"; extra-overlays = {}; } ## create-overlays { src = ./my-overlays; packages-src = ./my-packages; package-namespace = "my-namespace"; extra-overlays = {}; }
# result: { default = final: prev: ...; some-overlay = final: prev: ...; } ## ```
## Result:
## ```nix
## { default = final: prev: ...; some-overlay = final: prev: ...; }
## ```
#@ Attrs -> Attrs
create-overlays = create-overlays =
{ src ? user-overlays-root { src ? user-overlays-root
, packages-src ? user-packages-root , packages-src ? user-packages-root

14
snowfall-lib/package/default.nix
View file

@ -12,10 +12,16 @@ let
in in
{ {
package = rec { package = rec {
# Create flake output packages. ## Create flake output packages.
# Type: Attrs -> Attrs ## Example Usage:
# Usage: create-packages { inherit channels; src = ./my-packages; overrides = { inherit another-package; }; alias.default = "another-package"; } ## ```nix
# result: { another-package = ...; my-package = ...; default = ...; } ## 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 = create-packages =
{ channels { channels
, src ? user-packages-root , src ? user-packages-root

84
snowfall-lib/path/default.nix
View file

@ -12,10 +12,16 @@ let
in in
{ {
path = rec { path = rec {
# Split a file name and its extension. ## Split a file name and its extension.
# Type: String -> [String] ## Example Usage:
# Usage: split-file-extension "my-file.md" ## ```nix
# result: [ "my-file" "md" ] ## split-file-extension "my-file.md"
## ```
## Result:
## ```nix
## [ "my-file" "md" ]
## ```
#@ String -> [String]
split-file-extension = file: split-file-extension = file:
let let
match = builtins.match file-name-regex file; 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."; assert assertMsg (match != null) "lib.snowfall.split-file-extension: File must have an extension to split.";
match; match;
# Check if a file name has a file extension. ## Check if a file name has a file extension.
# Type: String -> Bool ## Example Usage:
# Usage: has-any-file-extension "my-file.txt" ## ```nix
# result: true ## has-any-file-extension "my-file.txt"
## ```
## Result:
## ```nix
## true
## ```
#@ String -> Bool
has-any-file-extension = file: has-any-file-extension = file:
let let
match = builtins.match file-name-regex (toString file); match = builtins.match file-name-regex (toString file);
in in
match != null; match != null;
# Get the file extension of a file name. ## Get the file extension of a file name.
# Type: String -> String ## Example Usage:
# Usage: get-file-extension "my-file.final.txt" ## ```nix
# result: "txt" ## get-file-extension "my-file.final.txt"
## ```
## Result:
## ```nix
## "txt"
## ```
#@ String -> String
get-file-extension = file: get-file-extension = file:
if has-any-file-extension file then if has-any-file-extension file then
let let
@ -46,26 +64,44 @@ in
else else
""; "";
# Check if a file name has a specific file extension. ## Check if a file name has a specific file extension.
# Type: String -> String -> Bool ## Example Usage:
# Usage: has-file-extension "txt" "my-file.txt" ## ```nix
# result: true ## has-file-extension "txt" "my-file.txt"
## ```
## Result:
## ```nix
## true
## ```
#@ String -> String -> Bool
has-file-extension = extension: file: has-file-extension = extension: file:
if has-any-file-extension file then if has-any-file-extension file then
extension == get-file-extension file extension == get-file-extension file
else else
false; false;
# Get the parent directory for a given path. ## Get the parent directory for a given path.
# Type: Path -> Path ## Example Usage:
# Usage: get-parent-directory "/a/b/c" ## ```nix
# result: "/a/b" ## get-parent-directory "/a/b/c"
## ```
## Result:
## ```nix
## "/a/b"
## ```
#@ Path -> Path
get-parent-directory = snowfall-lib.fp.compose baseNameOf dirOf; get-parent-directory = snowfall-lib.fp.compose baseNameOf dirOf;
# Get the file name of a path without its extension. ## Get the file name of a path without its extension.
# Type: Path -> String ## Example Usage:
# Usage: get-file-name-without-extension ./some-directory/my-file.pdf ## ```nix
# result: "my-file" ## get-file-name-without-extension ./some-directory/my-file.pdf
## ```
## Result:
## ```nix
## "my-file"
## ```
#@ Path -> String
get-file-name-without-extension = path: get-file-name-without-extension = path:
let let
file-name = baseNameOf path; file-name = baseNameOf path;

14
snowfall-lib/shell/default.nix
View file

@ -12,10 +12,16 @@ let
in in
{ {
shell = { shell = {
# Create flake output packages. ## Create flake output packages.
# Type: Attrs -> Attrs ## Example Usage:
# Usage: create-shells { inherit channels; src = ./my-shells; overrides = { inherit another-shell; }; alias = { default = "another-shell"; }; } ## ```nix
# result: { another-shell = ...; my-shell = ...; default = ...; } ## 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 = create-shells =
{ channels { channels
, src ? user-shells-root , src ? user-shells-root

154
snowfall-lib/system/default.nix
View file

@ -15,39 +15,69 @@ let
in in
{ {
system = rec { system = rec {
# Get the name of a system based on its file path. ## Get the name of a system based on its file path.
# Type: Path -> String ## Example Usage:
# Usage: get-inferred-system-name "/systems/my-system/default.nix" ## ```nix
# result: "my-system" ## get-inferred-system-name "/systems/my-system/default.nix"
## ```
## Result:
## ```nix
## "my-system"
## ```
#@ Path -> String
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;
# Check whether a named system is macOS. ## Check whether a named system is macOS.
# Type: String -> Bool ## Example Usage:
# Usage: is-darwin "x86_64-linux" ## ```nix
# result: false ## is-darwin "x86_64-linux"
## ```
## Result:
## ```nix
## false
## ```
#@ String -> Bool
is-darwin = hasInfix "darwin"; is-darwin = hasInfix "darwin";
# Check whether a named system is Linux. ## Check whether a named system is Linux.
# Type: String -> Bool ## Example Usage:
# Usage: is-linux "x86_64-linux" ## ```nix
# result: false ## is-linux "x86_64-linux"
## ```
## Result:
## ```nix
## false
## ```
#@ String -> Bool
is-linux = hasInfix "linux"; is-linux = hasInfix "linux";
# Check whether a named system is virtual. ## Check whether a named system is virtual.
# Type: String -> Bool ## Example Usage:
# Usage: is-virtual "x86_64-iso" ## ```nix
# result: true ## is-virtual "x86_64-iso"
## ```
## Result:
## ```nix
## true
## ```
#@ String -> Bool
is-virtual = target: is-virtual = target:
(get-virtual-system-type target) != ""; (get-virtual-system-type target) != "";
# Get the virtual system type of a system target. ## Get the virtual system type of a system target.
# Type: String -> String ## Example Usage:
# Usage: get-virtual-system-type "x86_64-iso" ## ```nix
# result: "iso" ## get-virtual-system-type "x86_64-iso"
## ```
## Result:
## ```nix
## "iso"
## ```
#@ String -> String
get-virtual-system-type = target: get-virtual-system-type = target:
foldl foldl
(result: virtual-system: (result: virtual-system:
@ -59,10 +89,16 @@ in
"" ""
virtual-systems; virtual-systems;
# Get structured data about all systems for a given target. ## Get structured data about all systems for a given target.
# Type: String -> [Attrs] ## Example Usage:
# Usage: get-target-systems-metadata "x86_64-linux" ## ```nix
# result: [ { target = "x86_64-linux"; name = "my-machine"; path = "/systems/x86_64-linux/my-machine"; } ] ## 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: get-target-systems-metadata = target:
let let
systems = snowfall-lib.fs.get-directories target; systems = snowfall-lib.fs.get-directories target;
@ -82,10 +118,16 @@ in
in in
system-configurations; system-configurations;
# Get the system builder for a given target. ## Get the system builder for a given target.
# Type: String -> Function ## Example Usage:
# Usage: get-system-builder "x86_64-iso" ## ```nix
# result: (args: <system>) ## get-system-builder "x86_64-iso"
## ```
## Result:
## ```nix
## (args: <system>)
## ```
#@ String -> Function
get-system-builder = target: get-system-builder = target:
let let
virtual-system-type = get-virtual-system-type target; virtual-system-type = get-virtual-system-type target;
@ -130,10 +172,16 @@ in
else else
linux-system-builder; linux-system-builder;
# Get the flake output attribute for a system target. ## Get the flake output attribute for a system target.
# Type: String -> String ## Example Usage:
# Usage: get-system-output "aarch64-darwin" ## ```nix
# result: "darwinConfigurations" ## get-system-output "aarch64-darwin"
## ```
## Result:
## ```nix
## "darwinConfigurations"
## ```
#@ String -> String
get-system-output = target: get-system-output = target:
let let
virtual-system-type = get-virtual-system-type target; virtual-system-type = get-virtual-system-type target;
@ -145,10 +193,16 @@ in
else else
"nixosConfigurations"; "nixosConfigurations";
# Get the resolved (non-virtual) system target. ## Get the resolved (non-virtual) system target.
# Type: String -> String ## Example Usage:
# Usage: get-resolved-system-target "x86_64-iso" ## ```nix
# result: "x86_64-linux" ## get-resolved-system-target "x86_64-iso"
## ```
## Result:
## ```nix
## "x86_64-linux"
## ```
#@ String -> String
get-resolved-system-target = target: get-resolved-system-target = target:
let let
virtual-system-type = get-virtual-system-type target; virtual-system-type = get-virtual-system-type target;
@ -158,10 +212,16 @@ in
else else
target; target;
# Create a system. ## Create a system.
# Type: Attrs -> Attrs ## Example Usage:
# Usage: create-system { path = ./systems/my-system; } ## ```nix
# result: <flake-utils-plus-system-configuration> ## create-system { path = ./systems/my-system; }
## ```
## Result:
## ```nix
## <flake-utils-plus-system-configuration>
## ```
#@ Attrs -> Attrs
create-system = create-system =
{ target ? "x86_64-linux" { target ? "x86_64-linux"
, system ? get-resolved-system-target target , system ? get-resolved-system-target target
@ -199,10 +259,16 @@ in
}; };
}; };
# Create all available systems. ## Create all available systems.
# Type: Attrs -> Attrs ## Example Usage:
# Usage: create-systems { hosts.my-host.specialArgs.x = true; modules.nixos = [ my-shared-module ]; } ## ```nix
# result: { my-host = <flake-utils-plus-system-configuration>; } ## 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 ? { } }: create-systems = { systems ? { }, homes ? { } }:
let let
targets = snowfall-lib.fs.get-directories user-systems-root; targets = snowfall-lib.fs.get-directories user-systems-root;

16
snowfall-lib/template/default.nix
View file

@ -12,10 +12,18 @@ let
in in
{ {
template = { template = {
# Create flake templates. ## Create flake templates.
# Type: Attrs -> Attrs ##
# Usage: create-templates { src = ./my-templates; overrides = { inherit another-template; }; alias = { default = "another-template"; }; } ## Example Usage:
# result: { another-template = ...; my-template = ...; default = ...; } ## ```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 = create-templates =
{ src ? user-templates-root { src ? user-templates-root
, overrides ? { } , overrides ? { }