The nfh helps you generate lists of files from your Nix File Hierarchy.
Have you ever dreamed about auto imports? About disabling some of them? Then
nfh is for you!
At the first call, nfh generates an attribute set representing the structure
of the specified directory. Only nix files are included. Any default.nix
file is assigned the attribute name self.
> tree modules/
modules/
├── auth.nix
├── boot.nix
├── desktop
│ ├── firefox.nix
│ ├── foot.nix
│ ├── kde
│ │ ├── default.nix
│ │ └── krunner.nix
│ └── sway
│ ├── default.nix
│ ├── swayidle.nix
│ └── systemd-integration.nix
└── networking
├── iwd.nix
├── networkd.nix
├── openssh.nix
└── tor.nixnix-repl> fileSet = inputs.nfh ./modules
nix-repl> :p lib.filterAttrsRecursive (name: _: name != "__functor") fileSet
{
auth = modules/auth.nix;
boot = modules/boot.nix;
desktop = {
firefox = modules/desktop/firefox.nix;
foot = modules/desktop/foot.nix;
kde = {
krunner = modules/desktop/kde/krunner.nix;
self = modules/desktop/kde/default.nix;
};
sway = {
self = modules/desktop/sway/default.nix;
swayidle = modules/desktop/sway/swayidle.nix;
systemd-integration = modules/desktop/sway/systemd-integration.nix;
};
};
networking = {
iwd = modules/networking/iwd.nix;
networkd = modules/networking/networkd.nix;
openssh = modules/networking/openssh.nix;
tor = modules/networking/tor.nix;
};
}This also recursively adds a functor to each attribute set, which allows you easily convert a specific part of your file hierarchy into a list of files:
nix-repl> fileSet { }
[
modules/auth.nix
modules/boot.nix
modules/desktop/firefox.nix
modules/desktop/foot.nix
modules/desktop/kde/krunner.nix
modules/desktop/kde/default.nix
modules/desktop/sway/default.nix
modules/desktop/sway/swayidle.nix
modules/desktop/sway/systemd-integration.nix
modules/networking/iwd.nix
modules/networking/networkd.nix
modules/networking/openssh.nix
modules/networking/tor.nix
]nix-repl> fileSet {
auth = false;
desktop.sway = false;
networking.tor = false;
}
[
modules/boot.nix
modules/desktop/firefox.nix
modules/desktop/foot.nix
modules/desktop/kde/krunner.nix
modules/desktop/kde/default.nix
modules/networking/iwd.nix
modules/networking/networkd.nix
modules/networking/openssh.nix
]nix-repl> fileSet.desktop.sway { }
[
modules/desktop/sway/default.nix
modules/desktop/sway/swayidle.nix
modules/desktop/sway/systemd-integration.nix
]You can use two special attributes to override default values:
_defaultsRecursive: recursively overrides default values with the specified value._defaults: overrides default values at the current directory/level.
Note: These attributes override values that represent files only, not directories.
Processing. Attributes are processed from the top level down through the
hierarchy, level by level. At each level,_defaultsRecursive is applied first,
followed by _defaults. Each time, previous values are overridden by the new
ones.
nix-repl> fileSet {
_defaultsRecursive = false;
networking = true;
desktop = {
_defaultsRecursive = true;
firefox = false;
sway = false;
};
}
[
modules/desktop/foot.nix
modules/desktop/kde/krunner.nix
modules/desktop/kde/default.nix
modules/networking/iwd.nix
modules/networking/networkd.nix
modules/networking/openssh.nix
modules/networking/tor.nix
]nix-repl> fileSet {
desktop.sway = {
_defaults = false;
swayidle = true;
};
}
[
modules/auth.nix
modules/boot.nix
modules/desktop/firefox.nix
modules/desktop/foot.nix
modules/desktop/kde/krunner.nix
modules/desktop/kde/default.nix
modules/desktop/sway/swayidle.nix
modules/networking/iwd.nix
modules/networking/networkd.nix
modules/networking/openssh.nix
modules/networking/tor.nix
]nix-repl> fileSet {
_defaultsRecursive = false;
_defaults = true;
desktop.kde = true;
}
[
modules/auth.nix
modules/boot.nix
modules/desktop/kde/krunner.nix
modules/desktop/kde/default.nix
]Start with the template and follow the steps described in its readme.
nix --extra-experimental-features 'flakes nix-command' flake init -t github:name-snrl/nfhAlso check out the author's configuration.