awesomeua / phpcs-pre-commit-hook
提交前使用PHPCS和noVerify检查
1.0
2019-06-05 14:21 UTC
Requires
This package is not auto-updated.
Last update: 2024-09-20 09:47:00 UTC
README
关于
自动安装git pre-commit钩子,用于在提交前运行PHP Code Sniffer代码检查,以确保符合PSR2编码标准。它仅检查要提交的文件。
受到使用composer、git钩子和phpcs强制执行代码标准和https://github.com/smgladkovskiy/phpcs-git-pre-commit以及https://gist.github.com/BrizzleRocker/62ed61b37acf05344d4bce894e719251的启发。安装程序会检查托管机器上的操作系统,并为平台安装所需的钩子。
安装
使用composer require命令安装awesomeua/phpcs-pre-commit-hook
composer require "awesomeua/phpcs-pre-commit-hook"
或者,手动在composer.json文件中包含对awesomeua/phpcs-pre-commit-hook
的依赖
{
"require-dev": {
"awesomeua/phpcs-pre-commit-hook": "*"
}
}
为了启用代码嗅探,在composer.json
安装脚本中的post-install-cmd
和post-update-cmd
中添加
"scripts": {
"post-install-cmd": [
"PHPCodeChecker\\Installer::postInstall"
],
"post-update-cmd": [
"PHPCodeChecker\\Installer::postInstall"
]
}
然后运行composer install
或composer update
。如果已经存在,则将安装或更新pre-commit
钩子。
用法
运行git commit
,pre-commit钩子将检查您提交的文件,就像您运行了
php phpcs.phar --standard=PSR2 --colors --encoding=utf-8 -n -p /path/to/file.php