feat: register gc root for the generated .pre-commit-config.yaml

cachix · Aug 24, 2024 · 7f88be4 · 7f88be4
1 parent c8a5405
commit 7f88be4
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 4 deletions.
diff --git a/modules/pre-commit.nix b/modules/pre-commit.nix
@@ -2,6 +2,7 @@
 let
   inherit (lib)
     attrNames
+    boolToString
     concatStringsSep
     compare
     filterAttrs
@@ -281,6 +282,15 @@ in
           internal = true;
         };
 
+      addGcRoot = mkOption {
+        type = types.bool;
+        default = true;
+        description = ''
+          Whether to add the generated pre-commit-config.yaml to the garbage collector roots.
+          This prevents Nix from garbage-collecting the tools used in the hooks.
+        '';
+      };
+
       assertions = lib.mkOption {
         type = types.listOf types.unspecified;
         internal = true;
@@ -351,7 +361,11 @@ in
                 echo 1>&2 "    2. remove .pre-commit-config.yaml"
                 echo 1>&2 "    3. add .pre-commit-config.yaml to .gitignore"
               else
-                ln -fs ${configFile} "''${GIT_WC}/.pre-commit-config.yaml"
+                if [ "${boolToString cfg.addGcRoot}" = "true" ]; then
+                  nix-store --add-root "''${GIT_WC}/.pre-commit-config.yaml" --realise ${configFile}
+                else
+                  ln -fs ${configFile} "''${GIT_WC}/.pre-commit-config.yaml"
+                fi
                 # Remove any previously installed hooks (since pre-commit itself has no convergent design)
                 hooks="${concatStringsSep " " (remove "manual" supportedHooksLib.supportedHooks )}"
                 for hook in $hooks; do

diff --git a/nix/installation-test.nix b/nix/installation-test.nix
@@ -1,5 +1,5 @@
 # Test that checks whether the correct hooks are created in the hooks folder.
-{ git, perl, coreutils, runCommand, run, lib, mktemp }:
+{ git, perl, nix, coreutils, runCommand, run, lib, mktemp }:
 let
   tests = {
     basic-test = {
@@ -61,7 +61,7 @@ let
 
   executeTest = lib.mapAttrsToList
     (name: test:
-      let runDerivation = run ({ src = null; } // test.conf);
+      let runDerivation = run ({ src = null; addGcRoot = false; } // test.conf);
       in ''
         rm -f ~/.git/hooks/*
         ${runDerivation.shellHook}

diff --git a/nix/run.nix b/nix/run.nix
@@ -6,6 +6,7 @@ builtinStuff@{ pkgs, tools, isFlakes, pre-commit, git, runCommand, writeText, wr
 , excludes ? [ ]
 , tools ? { }
 , default_stages ? [ "commit" ]
+, addGcRoot ? true
 , imports ? [ ]
 }:
 let
@@ -19,7 +20,7 @@ let
               {
                 _module.args.pkgs = pkgs;
                 _module.args.gitignore-nix-src = gitignore-nix-src;
-                inherit hooks excludes default_stages settings;
+                inherit hooks excludes default_stages settings addGcRoot;
                 tools = builtinStuff.tools // tools;
                 package = pre-commit;
               } // (if isFlakes