feat: add pre-commit hook to check TODO|FIXME|FIX comment

This commit is contained in:
danny 2026-01-10 13:28:41 +08:00
parent cf005ff872
commit 2378a66114
4 changed files with 43 additions and 7 deletions

View file

@ -0,0 +1,19 @@
{ pkgs, lib }:
pkgs.writeShellScript "check-comment" ''
FILES=$("${lib.getExe pkgs.git}" diff --cached --name-only --diff-filter=ACM | grep '\.nix$' | grep -v '^githooks/check-comment.nix$')
TODO_FOUND=0
for file in $FILES; do
if grep -nHE '#\s*(TODO|FIXME|FIX):' "$file"; then
TODO_FOUND=1
fi
done
if [ $TODO_FOUND -eq 1 ]; then
echo "Remove all the '#TODO|FIXME|FIX' before committing"
exit 1
fi
exit 0
''