normalize documentation (#16)

Author: kiriwalawren

modules/arr-common/downloadClients.nix

@@ -32,6 +32,18 @@ in {
       };
     });
     default = [];
+    defaultText = literalExpression ''
+      lib.optionals (config.nixflix.sabnzbd.enable or false) [
+        {
+          name = "SABnzbd";
+          implementationName = "SABnzbd";
+          apiKeyPath = config.nixflix.sabnzbd.apiKeyPath;
+          host = config.nixflix.sabnzbd.settings.host;
+          port = config.nixflix.sabnzbd.settings.port;
+          urlBase = config.nixflix.sabnzbd.settings.url_base;
+        }
+      ]
+    '';
     description = ''
       List of download clients to configure via the API /downloadclient endpoint.
       Any additional attributes beyond name, implementationName, and apiKeyPath

modules/arr-common/hostConfigType.nix

@@ -52,6 +52,7 @@ with lib;
       urlBase = mkOption {
         type = types.str;
         default = "";
+        defaultText = literalExpression ''if config.nixflix.serviceNameIsUrlBase then "/<serviceName>" else ""'';
         description = "URL base path";
       };
 

modules/arr-common/mkArrServiceModule.nix

@@ -53,6 +53,26 @@ with lib; let
           };
         };
       };
+      defaultText = lib.literalExpression ''
+        {
+          auth = {
+            required = "Enabled";
+            method = "Forms";
+          };
+          server = {
+            inherit (config.nixflix.${serviceName}.config.hostConfig) port urlBase;
+          };
+        } // lib.optionalAttrs config.services.postgresql.enable {
+          log.dbEnabled = true;
+          postgres = {
+            user = config.nixflix.${serviceName}.user;
+            host = "/run/postgresql";
+            port = 5432;
+            mainDb = config.nixflix.${serviceName}.user;
+            logDb = config.nixflix.${serviceName}.user;
+          };
+        }
+      '';
       example = lib.options.literalExpression ''
         {
           update.mechanism = "internal";
@@ -160,6 +180,7 @@ in {
       mediaDirs = mkOption {
         type = types.listOf types.path;
         default = [];
+        defaultText = literalExpression ''[config.nixflix.mediaDir + "/<media-type>"]'';
         description = "List of media directories to create and manage";
       };
     };

modules/arr-common/rootFolders.nix

@@ -10,6 +10,7 @@ in {
   options = mkOption {
     type = types.listOf types.attrs;
     default = [];
+    defaultText = literalExpression ''map (mediaDir: {path = mediaDir;}) config.nixflix.<serviceName>.mediaDirs'';
     description = ''
       List of root folders to create via the API /rootfolder endpoint.
       Each folder is an attribute set that will be converted to JSON and sent to the API.

modules/mullvad.nix

@@ -45,6 +45,7 @@ in {
         "8.8.8.8"
         "8.8.4.4"
       ];
+      defaultText = literalExpression ''["1.1.1.1" "1.0.0.1" "8.8.8.8" "8.8.4.4"]'';
       example = ["194.242.2.4" "194.242.2.3"];
       description = ''
         DNS servers to use with the VPN.

modules/prowlarr/applications.nix

@@ -26,6 +26,11 @@ in {
       };
     });
     default = [];
+    defaultText = literalExpression ''
+      # Automatically configured for enabled arr services (Sonarr, Radarr, Lidarr)
+      # Each enabled service gets an application entry with computed baseUrl and prowlarrUrl
+      # based on nginx configuration
+    '';
     description = ''
       List of applications to configure in Prowlarr.
       Any additional attributes beyond name, implementationName, and apiKeyPath

modules/sabnzbd/default.nix

@@ -36,12 +36,14 @@ in {
     group = mkOption {
       type = types.str;
       default = globals.libraryOwner.group;
+      defaultText = literalExpression "config.nixflix.globals.libraryOwner.group";
       description = "Group under which the service runs";
     };
 
     downloadsDir = mkOption {
       type = types.str;
       default = "${nixflix.downloadsDir}/usenet";
+      defaultText = literalExpression ''config.nixflix.downloadsDir + "/usenet"'';
       description = "Base directory for SABnzbd downloads";
     };
 

modules/sabnzbd/settingsType.nix

@@ -116,6 +116,7 @@ in
           if nixflix.nginx.enable
           then "/sabnzbd"
           else "/";
+        defaultText = lib.literalExpression ''if config.nixflix.nginx.enable then "/sabnzbd" else "/"'';
         description = "URL base path for the web interface";
       };
 
@@ -158,18 +159,21 @@ in
       download_dir = mkOption {
         type = types.str;
         default = "${cfg.downloadsDir}/incomplete";
+        defaultText = lib.literalExpression ''config.nixflix.sabnzbd.downloadsDir + "/incomplete"'';
         description = "Incomplete downloads directory";
       };
 
       complete_dir = mkOption {
         type = types.str;
         default = "${cfg.downloadsDir}/complete";
+        defaultText = lib.literalExpression ''config.nixflix.sabnzbd.downloadsDir + "/complete"'';
         description = "Complete downloads directory";
       };
 
       dirscan_dir = mkOption {
         type = types.str;
         default = "${cfg.downloadsDir}/watch";
+        defaultText = lib.literalExpression ''config.nixflix.sabnzbd.downloadsDir + "/watch"'';
         description = "Directory to watch for NZB files";
       };
 
@@ -182,18 +186,21 @@ in
       nzb_backup_dir = mkOption {
         type = types.str;
         default = "${cfg.downloadsDir}/nzb-backup";
+        defaultText = lib.literalExpression ''config.nixflix.sabnzbd.downloadsDir + "/nzb-backup"'';
         description = "NZB backup directory";
       };
 
       admin_dir = mkOption {
         type = types.str;
         default = "${cfg.downloadsDir}/admin";
+        defaultText = lib.literalExpression ''config.nixflix.sabnzbd.downloadsDir + "/admin"'';
         description = "Admin directory";
       };
 
       log_dir = mkOption {
         type = types.str;
         default = "${cfg.downloadsDir}/logs";
+        defaultText = lib.literalExpression ''config.nixflix.sabnzbd.downloadsDir + "/logs"'';
         description = "Log directory";
       };
 
@@ -427,6 +434,24 @@ in
             script = "None";
           }
         ];
+        example = lib.literalExpression ''
+          [
+            {
+              name = "movies";
+              dir = "movies";
+              priority = 0;
+              pp = 3;
+              script = "None";
+            }
+            {
+              name = "tv";
+              dir = "tv";
+              priority = 0;
+              pp = 3;
+              script = "None";
+            }
+          ]
+        '';
         description = "Download categories";
       };
     };