PHP-CS-Fixer Pre-Commit Hook
Automatically executing a code style check before commits can save you time. You can use a git hook to automatically run scripts before a commit.
In this post I'll show you how to setup PHP Coding Standards Fixer to automatically run before a commit. If the check fails, the commit will abort. You can bypass checks with git commit --no-verify.
Setup the Git hooks location
Hooks can installed local for a current repository or globally for all repositories. The hooks are all stored in the hooks subdirectory of the Git directory. In most projects that's .git/hooks. You can set a custom location by setting core.hooksPath.
Set hooks path globally for all repositories:
git config --global core.hooksPath ~/.githooksSet hooks path for local repository:
git config core.hooksPath ~/.githooksA simple example hook
Create a pre-commit script that prints "Hello world".
echo 'echo "Hello world"' > ~/.githooks/pre-commitMake sure the script is executable.
chmod 744 ~/.githooks/pre-commit
Now when you commit "Hello world" will be printed.
$ git commit -m "commit message"
Hello worldHook exit status
When a hook script exits with a non-zero status from this script causes the git commit command to abort before creating a commit. The Git documentation provides a list of possible hooks you can use: Git Hooks documentation.
Setup PHP-CS-Fixer
Printing Hello world is not particularly exciting or useful. Let's take a look at something more useful: running a php-cs-fixer check before committing.
The PHP Coding Standards Fixer (PHP CS Fixer) tool fixes your code to follow standards; whether you want to follow PHP coding standards as defined in the PSR-1, PSR-2, etc., or other community driven ones like the Symfony one.
Here is an out-of-the-box example of PHP-CS-FIXER pre commit hook:
PHP Coding Standards Fixer pre commit hook.
This may be overkill for your needs so copy and modify. It will run php-cs-fixer in quiet mode before commits and if there is violation it will re-run it with details such as diff of the issue. It's easy enough to install:
Create a Git hooks directory:
mkdir ~/.githooksConfigure Git to use the hooks:
git config --global core.hooksPath ~/.githooksDownload or copy the pre-commit hook to your Git hooks location:
Make sure the file is executable:
chmod 744 ~/.githooks/pre-commitEnjoy!