From 8c9f699269a47ce03392d4df4f37a952f5b19deb Mon Sep 17 00:00:00 2001
From: DashieTM <fabio.lenherr@gmail.com>
Date: Sun, 25 Aug 2024 18:16:09 +0200
Subject: [PATCH] Add inline documentation for lib

---
 lib/default.nix | 91 ++++++++++++++++++++++++++++---------------------
 1 file changed, 53 insertions(+), 38 deletions(-)

diff --git a/lib/default.nix b/lib/default.nix
index 225bdd5..8188fb3 100644
--- a/lib/default.nix
+++ b/lib/default.nix
@@ -1,48 +1,63 @@
-{ inputs, pkgs, ... }: {
-  /* *
-     Builds system given a list of system names which are placed within your hosts/ directory. Note that each system has its own directory in hosts/ as well.
+{ inputs, pkgs, ... }:
+{
+  /**
+    Builds system given a list of system names which are placed within your hosts/ directory. Note that each system has its own directory in hosts/ as well.
 
-     A minimal configuration requires the file configuration.nix within each system directory, this will be the base config that is used across both NisOS and home-manager, specific optional files can also be added, hardware.nix for NisOS configuration and home.nix for home-manager configuration.
+    A minimal configuration requires the file configuration.nix within each system directory, this will be the base config that is used across both NisOS and home-manager, specific optional files can also be added, hardware.nix for NisOS configuration and home.nix for home-manager configuration.
 
-     The second parameter is the root of your configuration, which should be ./. in most cases.
+    The second parameter is the root of your configuration, which should be ./. in most cases.
 
-     # Inputs
+    # Inputs
 
-     `systems`
+    `systems`
 
-     : a list of strings with hostnames
+    : a list of strings with hostnames
 
-     `root`
+    `root`
 
-     : the root path of your configuration
+    : the root path of your configuration
 
-     # Example usage
-     :::{.example}
-     ```nix
-     nixosConfigurations =
-         (inputs.dashNix.dashNixLib.build_systems [ "nixos" ] ./.);
-     ```
-     :::
+    # Example usage
+    :::{.example}
+    ```nix
+    nixosConfigurations =
+        (build_systems [ "nixos" ] ./.);
+    ```
+    :::
   */
-  build_systems = systems: root:
-    builtins.listToAttrs (map (name: {
-      name = name;
-      value = let
-        mod = root + /hosts/${name}/configuration.nix;
-        additionalNixosConfig = root + /hosts/${name}/hardware.nix;
-        additionalHomeConfig = root + /hosts/${name}/home.nix;
-      in inputs.nixpkgs.lib.nixosSystem {
-        specialArgs = { inherit inputs pkgs mod additionalHomeConfig root; };
-        modules = [
-          inputs.home-manager.nixosModules.home-manager
-          inputs.stylix.nixosModules.stylix
-          ../base
-          ../home
-          ../modules
-          mod
-        ] ++ inputs.nixpkgs.lib.optional
-          (builtins.pathExists additionalNixosConfig) additionalNixosConfig
-          ++ inputs.nixpkgs.lib.optional (builtins.pathExists mod) mod;
-      };
-    }) systems);
+  build_systems =
+    systems: root:
+    builtins.listToAttrs (
+      map (name: {
+        name = name;
+        value =
+          let
+            mod = root + /hosts/${name}/configuration.nix;
+            additionalNixosConfig = root + /hosts/${name}/hardware.nix;
+            additionalHomeConfig = root + /hosts/${name}/home.nix;
+          in
+          inputs.nixpkgs.lib.nixosSystem {
+            specialArgs = {
+              inherit
+                inputs
+                pkgs
+                mod
+                additionalHomeConfig
+                root
+                ;
+            };
+            modules =
+              [
+                inputs.home-manager.nixosModules.home-manager
+                inputs.stylix.nixosModules.stylix
+                ../base
+                ../home
+                ../modules
+                mod
+              ]
+              ++ inputs.nixpkgs.lib.optional (builtins.pathExists additionalNixosConfig) additionalNixosConfig
+              ++ inputs.nixpkgs.lib.optional (builtins.pathExists mod) mod;
+          };
+      }) systems
+    );
 }