Skip to content

Instantly share code, notes, and snippets.

@martinsotir
Created February 3, 2020 02:09
Show Gist options
  • Save martinsotir/9e93ddfc6d75610cb328ea62b2b44c9d to your computer and use it in GitHub Desktop.
Save martinsotir/9e93ddfc6d75610cb328ea62b2b44c9d to your computer and use it in GitHub Desktop.
Git pre-commit hook checking python code style with autopep8. Displays a colored diff on errors. Hook disabled when rebasing.
#!/bin/bash
#
# 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=4b825dc642cb6eb9a060e54bf8d69288fbee4904
fi
# If you want to allow non-ASCII filenames set this variable to true.
allownonascii=$(git config --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 --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
#################################################################
# Disable hook when rebasing:
# (https://superuser.com/a/1362934)
BRANCH_NAME=$(git branch | grep '*' | sed 's/* //')
if [[ $BRANCH_NAME == *"no branch"* ]]
then
exit 0
fi
NOCOLOR='\033[0m'
RED='\033[1;31m'
# First check format without printing:
# (one-liner modified from: https://gist.github.com/temoto/6183235#gistcomment-1780577 - gwillem)
git diff --cached $against --name-only | egrep '\.py$' | xargs --no-run-if-empty autopep8 -aa --exit-code > /dev/null
autopep_ret=$?
if [ $autopep_ret -ne 0 ]
then
echo -e "\n${RED}[Autopep8] validation failed${NOCOLOR}\n" >&2
# Rerun command with pretty color diff
git diff --cached --name-only | egrep '\.py$' | xargs --no-run-if-empty -I {} sh -c "autopep8 -aad {} | colordiff"
exit 1
fi
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment