From ca48fced83b37b4927ee264e54b9fdd5706c4139 Mon Sep 17 00:00:00 2001
From: mat ess <mat@mat.services>
Date: Mon, 28 Nov 2022 23:29:34 -0500
Subject: [PATCH] fish: format user and generated .fish files

Adds a `fishIndent` wrapper to pass fish scripts to the built in
`fish_indent` function.
---
 modules/programs/fish.nix                     | 76 ++++++++++++-------
 tests/modules/programs/fish/default.nix       |  1 +
 .../modules/programs/fish/format-scripts.nix  | 50 ++++++++++++
 3 files changed, 99 insertions(+), 28 deletions(-)
 create mode 100644 tests/modules/programs/fish/format-scripts.nix

diff --git a/modules/programs/fish.nix b/modules/programs/fish.nix
index 7eda6eb6b..50c7c5bb1 100644
--- a/modules/programs/fish.nix
+++ b/modules/programs/fish.nix
@@ -145,6 +145,16 @@ let
   aliasesStr = concatStringsSep "\n"
     (mapAttrsToList (k: v: "alias ${k} ${escapeShellArg v}") cfg.shellAliases);
 
+  fishIndent = name: text:
+    if cfg.formatFishScripts then
+      pkgs.runCommand name {
+        nativeBuildInputs = [ cfg.package ];
+        inherit text;
+        passAsFile = [ "text" ];
+      } "fish_indent < $textPath > $out"
+    else
+      pkgs.writeText name text;
+
 in {
   imports = [
     (mkRemovedOptionModule [ "programs" "fish" "promptInit" ] ''
@@ -279,6 +289,15 @@ in {
       '';
     };
 
+    programs.fish.formatFishScripts = mkOption {
+      type = types.bool;
+      default = false;
+      description = ''
+        Whether to process fish configuration and scripts with
+        <literal>fish_indent</literal>.
+      '';
+    };
+
   };
 
   config = mkIf cfg.enable (mkMerge [
@@ -340,7 +359,7 @@ in {
         end
       '';
 
-      xdg.configFile."fish/config.fish".text = ''
+      xdg.configFile."fish/config.fish".source = fishIndent "config.fish" ''
         # ~/.config/fish/config.fish: DO NOT EDIT -- this file has been generated
         # automatically by home-manager.
 
@@ -379,7 +398,7 @@ in {
       xdg.configFile = mapAttrs' (name: def: {
         name = "fish/functions/${name}.fish";
         value = {
-          text = let
+          source = let
             modifierStr = n: v: optional (v != null) ''--${n}="${toString v}"'';
             modifierStrs = n: v: optional (v != null) "--${n}=${toString v}";
             modifierBool = n: v: optional (v != null && v) "--${n}";
@@ -397,9 +416,9 @@ in {
 
             modifiers = if isAttrs def then " ${toString mods}" else "";
             body = if isAttrs def then def.body else def;
-          in ''
+          in fishIndent "${name}.fish" ''
             function ${name}${modifiers}
-              ${body}
+              ${lib.strings.removeSuffix "\n" body}
             end
           '';
         };
@@ -410,34 +429,35 @@ in {
     # in the paths and any initialization scripts.
     (mkIf (length cfg.plugins > 0) {
       xdg.configFile = mkMerge ((map (plugin: {
-        "fish/conf.d/plugin-${plugin.name}.fish".text = ''
-          # Plugin ${plugin.name}
-          set -l plugin_dir ${plugin.src}
+        "fish/conf.d/plugin-${plugin.name}.fish".source =
+          fishIndent "${plugin.name}.fish" ''
+            # Plugin ${plugin.name}
+            set -l plugin_dir ${plugin.src}
 
-          # Set paths to import plugin components
-          if test -d $plugin_dir/functions
-            set fish_function_path $fish_function_path[1] $plugin_dir/functions $fish_function_path[2..-1]
-          end
-
-          if test -d $plugin_dir/completions
-            set fish_complete_path $fish_complete_path[1] $plugin_dir/completions $fish_complete_path[2..-1]
-          end
-
-          # Source initialization code if it exists.
-          if test -d $plugin_dir/conf.d
-            for f in $plugin_dir/conf.d/*.fish
-              source $f
+            # Set paths to import plugin components
+            if test -d $plugin_dir/functions
+              set fish_function_path $fish_function_path[1] $plugin_dir/functions $fish_function_path[2..-1]
             end
-          end
 
-          if test -f $plugin_dir/key_bindings.fish
-            source $plugin_dir/key_bindings.fish
-          end
+            if test -d $plugin_dir/completions
+              set fish_complete_path $fish_complete_path[1] $plugin_dir/completions $fish_complete_path[2..-1]
+            end
 
-          if test -f $plugin_dir/init.fish
-            source $plugin_dir/init.fish
-          end
-        '';
+            # Source initialization code if it exists.
+            if test -d $plugin_dir/conf.d
+              for f in $plugin_dir/conf.d/*.fish
+                source $f
+              end
+            end
+
+            if test -f $plugin_dir/key_bindings.fish
+              source $plugin_dir/key_bindings.fish
+            end
+
+            if test -f $plugin_dir/init.fish
+              source $plugin_dir/init.fish
+            end
+          '';
       }) cfg.plugins));
     })
   ]);
diff --git a/tests/modules/programs/fish/default.nix b/tests/modules/programs/fish/default.nix
index 99fe81367..3ed5b9cfe 100644
--- a/tests/modules/programs/fish/default.nix
+++ b/tests/modules/programs/fish/default.nix
@@ -1,4 +1,5 @@
 {
+  fish-format-scripts = ./format-scripts.nix;
   fish-functions = ./functions.nix;
   fish-no-functions = ./no-functions.nix;
   fish-plugins = ./plugins.nix;
diff --git a/tests/modules/programs/fish/format-scripts.nix b/tests/modules/programs/fish/format-scripts.nix
new file mode 100644
index 000000000..2ba58cae1
--- /dev/null
+++ b/tests/modules/programs/fish/format-scripts.nix
@@ -0,0 +1,50 @@
+{ config, pkgs, ... }:
+
+let
+
+  expectedFunc = pkgs.writeText "func.fish" ''
+    function func
+        echo foo
+    end
+  '';
+
+  expectedFuncMulti = pkgs.writeText "func-multi.fish" ''
+    function func-multi
+        echo bar
+        if foo
+            bar
+            baz
+        end
+    end
+  '';
+
+in {
+  config = {
+    programs.fish = {
+      enable = true;
+
+      formatFishScripts = true;
+
+      functions = {
+        func = ''echo "foo"'';
+        func-multi = ''
+              echo bar
+          if foo
+              bar
+                  baz
+                end
+        '';
+      };
+    };
+
+    nmt.script = ''
+      assertFileExists home-files/.config/fish/functions/func.fish
+      echo ${expectedFunc}
+      assertFileContent home-files/.config/fish/functions/func.fish ${expectedFunc}
+
+      assertFileExists home-files/.config/fish/functions/func-multi.fish
+      echo ${expectedFuncMulti}
+      assertFileContent home-files/.config/fish/functions/func-multi.fish ${expectedFuncMulti}
+    '';
+  };
+}