Checks in our pre-commit hook
- Syntax check with php lint (“php -l”): We check every committed file has a valid PHP syntax.
- Sync check of composer.json and composer.lock files: We check these two files are committed together in order to avoid committing the json but not the lock and generate some issue to another developers.
- PHP CS Fixer check: With the –dry-run parameter it does not fix, just say what the problems are. With the –fixers parameter you can control what fixers you want to execute.
- PHP Code Sniffer check: Same as before, but another rule that checks another rules.
- PHPMD: We have enabled the controversial rules.
- Unit Testing check: We run around 3.000 tests right now.
INSTALLATION:
The recommended way to install this library is through Composer:
add juizmill/pre-commit
as a composer dependency.
composer.json
"require-dev": {
...
"juizmill/pre-commit": "dev-master"
}
php composer.phar update juizmill/pre-commit
USAGE:
When a developer clones the project, it just needs to:
Edit composer.json and add:
"scripts": {
"pre-update-cmd": "PreCommit\\Composer\\Script\\Hooks::preHooks",
"pre-install-cmd": "PreCommit\\Composer\\Script\\Hooks::preHooks",
"post-update-cmd": "PreCommit\\Composer\\Script\\Hooks::postHooks",
"post-install-cmd": "PreCommit\\Composer\\Script\\Hooks::postHooks"
}
or
cd [project]
rm -rf .git/hooks/pre-commit
cp vendor/juizmill/pre-commit/hooks/pre-commit .git/hooks/pre-commit
chmod -R 777 .git/hooks/pre-commit
Remembering to set up the hooks
Copy arquives vendor/juizmill/pre-commit/config/*
to [project]