Skip to content

feat: pre-commit hook for fmt #595

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

Merged
vladimirvolek merged 4 commits into from
Jun 23, 2026
Merged

feat: pre-commit hook for fmt #595

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b3d21d1
feat: pre-commit hook for fmt
vladimirvolek Jun 22, 2026
4d1f994
fix: dont abort devshell startup if .git is read-only
vladimirvolek Jun 22, 2026
8689787
fix(fmt): find the `treefmt` path dynamically for the pre-commit hook
michalrus Jun 22, 2026
d90cc41
fix(fmt): install `core.hooksPath` only when unset or an older versio…
michalrus Jun 23, 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
38 changes: 38 additions & 0 deletions nix/devshells.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,5 +156,43 @@ in {

ln -sfn ${internal.generated-dir} "$PRJ_ROOT/generated"
'';

startup.install-git-hooks.text = let
gitHooks = pkgs.runCommand "blockfrost-platform-git-hooks" {} ''
mkdir -p "$out"
ln -s ${
pkgs.writeShellScript "pre-commit" ''
set -euo pipefail

if [ -n "''${SKIP_TREEFMT+x}" ]; then
exit 0
fi

if "${lib.getExe inputs.self.formatter.${pkgs.stdenv.hostPlatform.system}}" --fail-on-change; then
exit 0
else
status=$?
echo >&2 'error: treefmt detected (and corrected) unformatted code'
echo >&2 'hint: set SKIP_TREEFMT=1 to skip treefmt in pre-commit'
exit "$status"
fi
''
} "$out/pre-commit"
'';
in ''
if [[ -e "$PRJ_ROOT/.git" ]] ; then
# Only manage `core.hooksPath` when it's unset or still points at a
# (possibly older) version of our own hooks; never clobber a
# contributor's own setup or hooks installed by other tooling.
current="$(git -C "$PRJ_ROOT" config --get core.hooksPath 2>/dev/null || true)"
if [[ -z "$current" || "$current" == /nix/store/*-blockfrost-platform-git-hooks ]] ; then
# Don't abort devshell startup if .git is read-only
git -C "$PRJ_ROOT" config --local core.hooksPath ${gitHooks} || true
else
echo >&2 "note: leaving your existing git core.hooksPath ($current) untouched"
echo >&2 "hint: the blockfrost-platform pre-commit (treefmt) hook was not installed"
fi
fi
'';
};
}
Loading