jv-testes / pre-commit
pre-commit 钩子
1.2.6
2015-08-26 19:37 UTC
Requires
- fabpot/php-cs-fixer: ^1.10
- phpmd/phpmd: ^2.2
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ^2.3
- symfony/process: ^2.7
README
在我们的 pre-commit 钩子中检查
- 语法检查(使用 php lint:“php -l”):我们检查每个提交的文件都有有效的 PHP 语法。
- composer.json 和 composer.lock 文件的同步检查:我们检查这两个文件一起提交,以避免只提交 json 而不提交 lock,从而给其他开发者造成一些问题。
- PHP CS Fixer 检查:使用 –dry-run 参数它不会修复,只是说明问题。使用 –fixers 参数您可以控制要执行的修复器。
- PHP Code Sniffer 检查:与之前相同,但检查其他规则。
- PHPMD:我们启用了有争议的规则。
- 单元测试检查:我们现在运行大约 3,000 个测试。
安装
安装此库的推荐方式是通过 Composer
将 jv-testes/pre-commit
添加为 composer 依赖项。
composer.json
"require-dev": { ... "jv-testes/pre-commit": ">=1.2.3" }
使用方法
当开发者克隆项目时,只需要
编辑 composer.json 并添加
"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"
}
记得设置钩子
自定义配置
将档案 vendor/jv-testes/pre-commit/config/*
复制到 [项目]