Skip to content

Instantly share code, notes, and snippets.

@michaeltcoelho
Last active December 20, 2018 16:08
Show Gist options
  • Save michaeltcoelho/37d7765bec57d7e098749a0f3bcd8977 to your computer and use it in GitHub Desktop.
Save michaeltcoelho/37d7765bec57d7e098749a0f3bcd8977 to your computer and use it in GitHub Desktop.
Lint python files on pre-commit
.PHONY: githooks
githooks:
@git config core.hooksPath .githooks
#!/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=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
# If there are whitespace errors, print the offending file names and fail.
# exec git diff-index --check --cached $against --
if pylint --version >/dev/null 2>&1; then
echo "Pylint already installed!" >/dev/null
else
echo "\n\033[40m\033[1;37m Installing Pylint... \033[0m\n"
pip install pylint
[[ $? -eq 0 ]] && echo "\n\033[40m\033[1;97m Pylint installed! \033[0m\n"
fi
python_files=$(git status --porcelain | awk '{ print $2 }' | grep .py)
ignored_pep8_errors="C0111"
if [ -z "$python_files" ]; then
echo "No python files to commit..." >/dev/null
else
echo "\n\033[40m\033[1;37m Running pylint against your python changed files... :)\033[0m\n"
for pyfile in $(git status --porcelain | awk '{ print $2 }' | grep .py); do
pylint -f colorized -d $ignored_pep8_errors -j 2 $pyfile
done
if [[ $? -eq 0 ]]; then
echo "\033[40m\033[1;97m Well done warrior, your python files are PEP8 compliant :) \033[0m\n"
exit 0
else
echo "\033[0;101m\033[1;97m Your code is not PEP8 compliant :( Fixt it!\033[0m\n"
exit 1
fi
fi
@michaeltcoelho
Copy link
Author

Run make githooks for changing git's hooks path

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment