foodogsquared/nixos-config
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/nixos-config.git synced 2025-01-30 22:57:55 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
462ddf9d7d
nixos-config/modules
History
Gabriel Arazas 6c34b5d2ee
docs: update modules README with design guidelines
2024-01-18 17:00:31 +08:00
..
flake-parts flake-parts/setups/nixos: init option to add home-manager users from declarative users setup 2024-01-18 16:54:16 +08:00
home-manager chore: reformat codebase 2024-01-01 13:56:10 +08:00
nixos nixos/workflows/a-happy-gnome: add more extensions 2024-01-17 17:58:34 +08:00
README.adoc docs: update modules README with design guidelines 2024-01-18 17:00:31 +08:00

README.adoc

Table of Contents

These are various modules ranging from NixOS modules and home-manager modules.

Design constraints

While there are different environments we can make modules with, there are commonalities between these custom modules. It’s better that we lay this out with a list of guidelines.

  • Absolutely no reliance on third-party modules. This makes the custom modules easier to import whether it’s used with flakes or not. Instead I recommend to make full use of environment-specific module structuring (such as host-specific modules on NixOS, user-specific modules on home-manager) on their respective environment configurations. As a bonus, this makes it easier to upstream them if we want to.

  • That said, custom modules can rely on other custom modules. Otherwise, we’re just limiting ourselves by forcing the modules to be standalone. Plus we could fix encountered issues with our own solution (and even upstream them if possible).

  • Follow the upstream module design as much as possible. This makes it easier to design custom module extensions around them. (Also a bonus for easier time upstreaming the module if I want to.)