fix: unset $PRJ_ROOT before running the repo's treefmt locally with t…

…reefmt-nix `numtide/devshell` sets $PRJ_ROOT, which is used to default `--tree-root`. This conflicts with `--tree-root-file` being set by `treefmt-nix`. Signed-off-by: Brian McGee <[email protected]>
numtide · Aug 1, 2024 · e384466 · e384466
1 parent e304d7a
commit e384466
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/nix/devshell.nix b/nix/devshell.nix
@@ -30,6 +30,16 @@ perSystem.devshell.mkShell {
 
   commands = [
     {package = perSystem.gomod2nix.default;}
+    # This custom command is needed to prevent a conflict between --tree-root and --tree-root-file.
+    # treefmt-nix sets --tree-root-file whilst treefmt defaults --tree-root from $PRJ_ROOT, which is set by numtide/devshell.
+    {
+      name = "fmt";
+      help = "runs `nix fmt` but unsets $PRJ_ROOT first";
+      package = pkgs.writeShellScriptBin "fmt" ''
+        unset PRJ_ROOT
+        nix fmt -- "$@"
+      '';
+    }
     {
       name = "docs:dev";
       help = "serve docs for local development";