Skip to content

Fix install.enable option and enable hook stage config in run derivation #689

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mitchallain wants to merge 6 commits into
base: master
Choose a base branch
from
+91 −47
Open

Fix install.enable option and enable hook stage config in run derivation #689

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
498f345
Add hook stage option
mitchallain Feb 13, 2026
ee4ddbd
Update installationScript to match option description and provide hel…
mitchallain Feb 13, 2026
6e94219
Docs
mitchallain Feb 13, 2026
1127ce5
Address review comments
mitchallain Feb 25, 2026
0cf55ed
Exit from new bash function for consistency with previous impl
mitchallain Feb 25, 2026
1e2c27c
Remove extra log messages for consistency with prev impl
mitchallain Feb 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 93 additions & 47 deletions modules/pre-commit.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,14 +100,13 @@ let
git config --global user.email "you@example.com"
git config --global user.name "Your Name"
git commit -m "init" -q
if [[ ${toString (compare cfg.installStages [ "manual" ])} -eq 0 ]]
Comment thread
sandydoo marked this conversation as resolved.
then
echo "Running: $ pre-commit run --hook-stage manual --all-files"
${lib.getExe cfg.package} run -c ${cfg.configPath} --hook-stage manual --all-files
else
${if cfg.runHookStage != null then ''
echo "Running: $ pre-commit run --hook-stage ${cfg.runHookStage} --all-files"
${lib.getExe cfg.package} run -c ${cfg.configPath} --hook-stage ${cfg.runHookStage} --all-files
'' else ''
echo "Running: $ pre-commit run --all-files"
${lib.getExe cfg.package} run -c ${cfg.configPath} --all-files
fi
${lib.getExe cfg.package} run -c ${cfg.configPath} --all-files
''}
exitcode=$?
git --no-pager diff --color
# Derivations must produce an output
Expand Down Expand Up @@ -278,6 +277,21 @@ in
defaultText = lib.literalExpression "<derivation>";
};

runHookStage =
mkOption {
type = types.nullOr types.str;
Comment thread
mitchallain marked this conversation as resolved.
Outdated
description =
''
The hook stage to run in the `run` derivation.

If set to `null` (default), pre-commit will run all hooks.
If set to a specific stage (e.g., "manual", "pre-commit", "pre-push"),
only hooks configured for that stage will run.
'';
default = null;
example = "manual";
};

shellHook =
mkOption {
type = types.str;
Expand Down Expand Up @@ -462,10 +476,73 @@ in

installationScript =
''
if ${boolToString cfg.install.enable}; then
# Define helper functions for managing git hooks
_git_hooks_uninstall() {
if ! ${cfg.gitPackage}/bin/git rev-parse --git-dir &> /dev/null; then
echo 1>&2 "WARNING: git-hooks.nix: .git not found; cannot uninstall hooks."
return 1
fi

echo 1>&2 "git-hooks.nix: uninstalling hooks"
# Remove any previously installed hooks (since pre-commit itself has no convergent design)
hooks="${concatStringsSep " " (remove "manual" supportedHooksLib.supportedHooks )}"
for hook in $hooks; do
${lib.getExe cfg.package} uninstall -t $hook
done
${lib.getExe cfg.gitPackage} config --local core.hooksPath ""
}

_git_hooks_install() {
if ! ${cfg.gitPackage}/bin/git rev-parse --git-dir &> /dev/null; then
echo 1>&2 "WARNING: git-hooks.nix: .git not found; skipping installation."
echo 1>&2 "WARNING: git-hooks.nix: .git not found; cannot install hooks."
return 1
fi

GIT_WC=`${lib.getExe cfg.gitPackage} rev-parse --show-toplevel`

if [ ! -L "''${GIT_WC}/${cfg.configPath}" ] || [[ $(readlink "''${GIT_WC}/${cfg.configPath}") != ${cfg.configFile} ]]; then
echo 1>&2 "WARNING: git-hooks.nix: config not properly set up. Please ensure the config symlink exists."
return 1
fi

echo 1>&2 "git-hooks.nix: installing hooks"
# Add hooks for configured stages (only) ...
if [ ! -z "${concatStringsSep " " install_stages}" ]; then
for stage in ${concatStringsSep " " install_stages}; do
case $stage in
manual)
;;
# if you amend these switches please also review $hooks above
commit | merge-commit | push)
stage="pre-"$stage
${lib.getExe cfg.package} install -c ${cfg.configPath} -t $stage
;;
${concatStringsSep "|" supportedHooksLib.supportedHooks})
${lib.getExe cfg.package} install -c ${cfg.configPath} -t $stage
;;
*)
echo 1>&2 "ERROR: git-hooks.nix: either $stage is not a valid stage or git-hooks.nix doesn't yet support it."
return 1
;;
esac
done
# ... or default 'pre-commit' hook
else
${lib.getExe cfg.package} install -c ${cfg.configPath}
fi

# Fetch the absolute path to the git common directory. This will normally point to $GIT_WC/.git.
common_dir=''$(${cfg.gitPackage}/bin/git rev-parse --path-format=absolute --git-common-dir)

# Convert the absolute path to a path relative to the toplevel working directory.
common_dir=''${common_dir#''$GIT_WC/}

${lib.getExe cfg.gitPackage} config --local core.hooksPath "''$common_dir/hooks"
}

if ! ${cfg.gitPackage}/bin/git rev-parse --git-dir &> /dev/null; then
echo 1>&2 "WARNING: git-hooks.nix: .git not found; skipping installation."
else
GIT_WC=`${lib.getExe cfg.gitPackage} rev-parse --show-toplevel`

# These update procedures compare before they write, to avoid
Expand All @@ -491,48 +568,17 @@ in
else
ln -fs ${cfg.configFile} "''${GIT_WC}/${cfg.configPath}"
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
${lib.getExe cfg.package} uninstall -t $hook
done
${lib.getExe cfg.gitPackage} config --local core.hooksPath ""
# Add hooks for configured stages (only) ...
if [ ! -z "${concatStringsSep " " install_stages}" ]; then
for stage in ${concatStringsSep " " install_stages}; do
case $stage in
manual)
;;
# if you amend these switches please also review $hooks above
commit | merge-commit | push)
stage="pre-"$stage
${lib.getExe cfg.package} install -c ${cfg.configPath} -t $stage
;;
${concatStringsSep "|" supportedHooksLib.supportedHooks})
${lib.getExe cfg.package} install -c ${cfg.configPath} -t $stage
;;
*)
echo 1>&2 "ERROR: git-hooks.nix: either $stage is not a valid stage or git-hooks.nix doesn't yet support it."
exit 1
;;
esac
done
# ... or default 'pre-commit' hook
else
${lib.getExe cfg.package} install -c ${cfg.configPath}
fi

# Fetch the absolute path to the git common directory. This will normally point to $GIT_WC/.git.
common_dir=''$(${cfg.gitPackage}/bin/git rev-parse --path-format=absolute --git-common-dir)

# Convert the absolute path to a path relative to the toplevel working directory.
common_dir=''${common_dir#''$GIT_WC/}

${lib.getExe cfg.gitPackage} config --local core.hooksPath "''$common_dir/hooks"
# Only manage hooks if install.enable is true
if ${boolToString cfg.install.enable}; then
# Uninstall any previously installed hooks
_git_hooks_uninstall
# Install new hooks
_git_hooks_install
fi
fi
fi
fi
fi
'';
};
}