Make the docs build

semnix · Nov 5, 2022 · 68079e4 · 68079e4
1 parent 59b6499
commit 68079e4
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/flake-module.nix b/flake-module.nix
@@ -25,7 +25,7 @@ in
                 Nixpkgs to use for pre-commit checking.
               '';
               default = pkgs;
-              defaultText = "pkgs  # module argument";
+              defaultText = lib.literalDocBook "<literal>pkgs</literal> (module argument)";
             };
             settings = mkOption {
               type = types.submoduleWith {
@@ -38,6 +38,7 @@ in
               type = types.str;
               description = "A bash fragment that sets up pre-commit.";
               default = cfg.settings.installationScript;
+              defaultText = lib.literalDocBook "bash statements";
               readOnly = true;
             };
           };

diff --git a/modules/hooks.nix b/modules/hooks.nix
@@ -112,6 +112,9 @@ in
               description =
                 "Prettier binary path. E.g. if you want to use the prettier in node_modules, use ./node_modules/.bin/prettier";
               default = "${tools.prettier}/bin/prettier";
+              defaultText = lib.literalExpression ''
+                "''${tools.prettier}/bin/prettier"
+              '';
             };
         };
       eslint =
@@ -122,6 +125,7 @@ in
               description =
                 "Eslint binary path. E.g. if you want to use the eslint in node_modules, use ./node_modules/.bin/eslint";
               default = "${tools.eslint}/bin/eslint";
+              defaultText = lib.literalExpression "\${tools.eslint}/bin/eslint";
             };
 
           extensions =

diff --git a/modules/pre-commit.nix b/modules/pre-commit.nix
@@ -44,7 +44,7 @@ let
               mkOption {
                 type = types.str;
                 default = name;
-                defaultText = literalExample "internal name, same as id";
+                defaultText = lib.literalDocBook or literalExample "internal name, same as id";
                 description =
                   ''
                     The name of the hook - shown during hook execution.
@@ -202,7 +202,7 @@ in
               The pre-commit package to use.
             '';
           defaultText =
-            literalExample ''
+            lib.literalExpression or literalExample ''
               pkgs.pre-commit
             '';
         };
@@ -217,7 +217,7 @@ in
               nix-pre-commit comes with its own set of packages for this purpose.
             '';
           defaultText =
-            literalExample ''pre-commit-hooks.nix-pkgs.callPackage tools-dot-nix { inherit (pkgs) system; }'';
+            lib.literalExpression or literalExample ''pre-commit-hooks.nix-pkgs.callPackage tools-dot-nix { inherit (pkgs) system; }'';
         };
 
       hooks =
@@ -240,6 +240,7 @@ in
             '';
           readOnly = true;
           default = run;
+          defaultText = "<derivation>";
         };
 
       installationScript =
@@ -270,7 +271,7 @@ in
 
               This is used in the derivation that performs the check.
             '';
-          defaultText = literalExample ''gitignoreSource config.src'';
+          defaultText = lib.literalExpression or literalExample ''gitignoreSource config.src'';
         };
 
       excludes =