latexindent: add hooks.latexindent.settings.extraConfig option

Replace the hooks.latexindent.settings.flags option with hooks.latexindent.settings.extraConfig to support arbitrary upstream flags and allow users to override default values. Link: cachix#514
trueNAHO · Oct 12, 2024 · 6c51b09 · 6c51b09
1 parent 06bb597
commit 6c51b09
Showing 1 changed file with 28 additions and 8 deletions.
diff --git a/modules/hooks.nix b/modules/hooks.nix
@@ -2,7 +2,7 @@
 let
   inherit (config) hooks tools settings;
   cfg = config;
-  inherit (lib) flatten mapAttrs mapAttrsToList mkDefault mkOption mkRemovedOptionModule mkRenamedOptionModule types;
+  inherit (lib) flatten mapAttrs mapAttrsToList mkDefault mkEnableOption mkOption mkRemovedOptionModule mkRenamedOptionModule types;
 
   cargoManifestPathArg =
     lib.optionalString
@@ -33,6 +33,11 @@ in
       (mkRemovedOptionModule [ "settings" "yamllint" "relaxed" ] ''
         This option has been removed. Use `hooks.yamllint.settings.preset = "relaxed"`.
       '')
+      (
+        mkRemovedOptionModule
+          [ "hooks" "latexindent" "settings" "flags" ]
+          "Use hooks.latexindent.settings.extraConfig instead."
+      )
     ]
     # Manually rename options that had a package or a config option
     ++ flatten (mapAttrsToList (name: map (o: mkRenamedOptionModule [ "settings" name o ] [ "hooks" name "settings" o ])) {
@@ -631,12 +636,17 @@ in
         type = types.submodule {
           imports = [ hookModule ];
           options.settings = {
-            flags =
-              mkOption {
-                type = types.str;
-                description = "Flags passed to latexindent. See available flags [here](https://latexindentpl.readthedocs.io/en/latest/sec-how-to-use.html#from-the-command-line)";
-                default = "--local --silent --overwriteIfDifferent";
-              };
+            extraConfig = mkOption {
+              type = types.attrs;
+              description = "[latexindent command-line options](https://latexindentpl.readthedocs.io/en/latest/sec-how-to-use.html#from-the-command-line) converted through `lib.cli.toGNUCommandLine`.";
+              default = { };
+
+              example = lib.literalExpression ''
+                {
+                  yaml = "defaultIndent: '    '";
+                }
+              '';
+            };
           };
         };
       };
@@ -2768,7 +2778,17 @@ lib.escapeShellArgs (lib.concatMap (ext: [ "--ghc-opt" "-X${ext}" ]) hooks.ormol
           description = "Perl script to add indentation to LaTeX files.";
           types = [ "file" "tex" ];
           package = tools.latexindent;
-          entry = "${hooks.latexindent.package}/bin/latexindent ${hooks.latexindent.settings.flags}";
+
+          entry = "${hooks.latexindent.package}/bin/latexindent ${
+            lib.cli.toGNUCommandLineShell {} (
+              {
+                local = true;
+                overwriteIfDifferent = true;
+                silent = true;
+              }
+              // hooks.latexindent.settings.extraConfig
+            )
+          }";
         };
       lacheck =
         let