hungpt / pre-commit-hook
提交前进行 PHPCS 检查
dev-master
2020-05-23 23:55 UTC
Requires
This package is auto-updated.
Last update: 2024-09-24 16:33:30 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 命令安装 hungpt/pre-commit-hook
composer require "hungpt/pre-commit-hook"
或者,您可以在 composer.json 文件中手动包含 hungpt/pre-commit-hook
的依赖项
{
"require-dev": {
"hungpt/pre-commit-hook": "*"
}
}
为了启用代码嗅探,将 post-install-cmd
和 post-update-cmd
添加到 composer.json
安装脚本中
"scripts": {
"post-install-cmd": [
"Hungpt\\PreCommitHook\\Installer::postInstall"
],
"post-update-cmd": [
"Hungpt\\PreCommitHook\\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