Skip to content

Instantly share code, notes, and snippets.

@vinitkumar
Created August 13, 2025 08:08
Show Gist options
  • Save vinitkumar/ddacf4a416083a51e6917f7ee1faab42 to your computer and use it in GitHub Desktop.
Save vinitkumar/ddacf4a416083a51e6917f7ee1faab42 to your computer and use it in GitHub Desktop.
Git pre commit hook for python projects using ruff, place it in .git/hooks/pre-commit, chmod +x .git/hooks/pre-commit
#!/bin/sh
#
# An example hook script to verify what is about to be committed.
# Called by "git commit" with no arguments. The hook should
# exit with non-zero status after issuing an appropriate message if
# it wants to stop the commit.
#
# To enable this hook, rename this file to "pre-commit".
if git rev-parse --verify HEAD >/dev/null 2>&1
then
against=HEAD
else
# Initial commit: diff against an empty tree object
against=$(git hash-object -t tree /dev/null)
fi
# If you want to allow non-ASCII filenames set this variable to true.
allownonascii=$(git config --type=bool hooks.allownonascii)
# Redirect output to stderr.
exec 1>&2
# Cross platform projects tend to avoid non-ASCII filenames; prevent
# them from being added to the repository. We exploit the fact that the
# printable range starts at the space character and ends with tilde.
if [ "$allownonascii" != "true" ] &&
# Note that the use of brackets around a tr range is ok here, (it's
# even required, for portability to Solaris 10's /usr/bin/tr), since
# the square bracket bytes happen to fall in the designated range.
test $(git diff-index --cached --name-only --diff-filter=A -z $against |
LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
then
cat <<\EOF
Error: Attempt to add a non-ASCII file name.
This can cause problems if you want to work with people on other platforms.
To be portable it is advisable to rename the file.
If you know what you are doing you can disable this check using:
git config hooks.allownonascii true
EOF
exit 1
fi
# Check Python files with ruff
python_files=$(git diff-index --cached --name-only --diff-filter=ACM $against | grep '\.py$')
if [ -n "$python_files" ]; then
echo "Running ruff check on Python files..."
for file in $python_files; do
if [ -f "$file" ]; then
echo "Checking $file with ruff..."
if ! uv run ruff check "$file" --fix; then
echo "Error: ruff check failed for $file"
echo "Please fix the issues and try committing again."
exit 1
fi
fi
done
echo "All Python files passed ruff check."
fi
# If there are whitespace errors, print the offending file names and fail.
exec git diff-index --check --cached $against --
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment