Last active
May 30, 2019 15:30
-
-
Save Glutnix/38bb14473a78d1542d97 to your computer and use it in GitHub Desktop.
Checking PSR-2 validation with PHPCS using a pre-commit git hook.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"require-dev": { | |
"squizlabs/php_codesniffer": "2.0.*@dev" | |
}, | |
"scripts": { | |
"post-install-cmd": [ | |
"bash contrib/setup.sh" | |
] | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#!/usr/bin/env bash | |
# Based on code from http://tech.zumba.com/2014/04/14/control-code-quality/ | |
PROJECT=$(php -r "echo dirname(dirname(dirname(realpath('$0'))));") | |
STAGED_FILES_CMD=$(git diff --cached --name-only --diff-filter=ACMR HEAD | grep \\.php) | |
# Determine if a file list is passed | |
if [ "$#" -eq 1 ] | |
then | |
oIFS=$IFS | |
IFS=' | |
' | |
SFILES="$1" | |
IFS=$oIFS | |
fi | |
SFILES=${SFILES:-$STAGED_FILES_CMD} | |
echo "Checking PHP Lint..." | |
for FILE in $SFILES | |
do | |
php -l -d display_errors=0 $PROJECT/$FILE | |
if [ $? != 0 ] | |
then | |
echo "Fix the error before commit." | |
exit 1 | |
fi | |
FILES="$FILES $PROJECT/$FILE" | |
done | |
if [ "$FILES" != "" ] | |
then | |
echo "Running Code Sniffer..." | |
TMP_DIR=/tmp/$(uuidgen) | |
mkdir -p $TMP_DIR | |
for FILE in $SFILES | |
do | |
mkdir -p $TMP_DIR/$(dirname $FILE) | |
git show :$FILE > $TMP_DIR/$FILE | |
done | |
./vendor/bin/phpcs --standard=PSR2 --encoding=utf-8 -n -p $TMP_DIR | |
PHPCS_ERROR=$? | |
rm -rf $TMP_DIR | |
if [ $PHPCS_ERROR != 0 ] | |
then | |
echo "Fix the error before commit." | |
exit 1 | |
fi | |
fi | |
exit $? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#!/usr/bin/env bash | |
cp contrib/pre-commit.sh .git/hooks/pre-commit | |
chmod +x .git/hooks/pre-commit |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I had an issue in uuidgen was not installed and the script did not make that immediately apparent (or I'm daft ;) )
I have forked and added a check for that, if you are interested. https://gist.github.com/Pilipo/e52ff5ac38fba9e1f5ed966816de41e9
I'm new to gist, but apparently pull requests aren't a thing yet. Too bad.
Thanks a lot for your work here. It has been very helpful to me!