Auto installed git pre-commit hook for running PHP Code Sniffer code checking to PSR2 coding standard compliance. It checks only files that are to be committed.
Inspired by Enforce code standards with composer, git hooks, and phpcs and https://github.com/smgladkovskiy/phpcs-git-pre-commit and https://gist.github.com/BrizzleRocker/62ed61b37acf05344d4bce894e719251 . Installer checks OS on hosting machine and installs needed hooks for platform.
Install thuanpt/phpcs-commit-hook
with composer require command:
composer require "thuanpt/phpcs-commit-hook"
Or alternatively, include a dependency for thuanpt/phpcs-commit-hook
in your composer.json file manually:
{
"require-dev": {
"thuanpt/phpcs-commit-hook": "*"
}
}
To enable code sniff, аdd to post-install-cmd
and post-update-cmd
in composer.json
installation script:
"scripts": {
"post-install-cmd": [
"PHPCodeChecker\\Installer::postInstall"
],
"post-update-cmd": [
"PHPCodeChecker\\Installer::postInstall"
]
}
Then run composer install
or composer update
. pre-commit
hook will be installed or updated if it already exists.
Run git commit
and pre-commit hook will check your committed files like if you run
php phpcs.phar --standard=PSR2 --colors --encoding=utf-8 -n -p /path/to/file.php