rugaard / git-hooks-php
PHP 相关的 Git 钩子。
1.0.0
2022-02-17 10:21 UTC
Requires
- php: ^8.0
- ext-json: *
- phpstan/phpstan: ^1.0
- phpunit/phpunit: ^9.0
- rugaard/git-hooks: ^1.0
- squizlabs/php_codesniffer: ^3.0
Requires (Dev)
- roave/security-advisories: dev-latest
README
这是一个“插件”包,可以无缝集成到Git Hooks包中。
它将安装 git
钩子,这些钩子将在您的项目 PHP 文件上自动运行多个检查,以确保它们不包含错误并遵循预期的编码标准。
📦 安装
您可以通过以下命令使用 Composer 安装此包
composer require rugaard/git-hooks rugaard/git-hooks-php
📝 配置
要更改一个或多个脚本的默认配置,您需要在项目根目录中有一个 git-hooks.config.json
文件。如果没有,可以使用以下命令创建它
./vendor/bin/git-hooks config
Rugaard\GitHooks\PHP\Hooks\PreCommit\PhpCodeStyleCommand
检查所有暂存的 .php
文件中的编码风格错误。
注意:默认情况下,如果没有提供有效的 config
,此命令将寻找 phpcs.xml
或 phpcs.xml.dist
作为替代。
如果找到这些选项中的任何一个,上述参数将被忽略,配置文件将具有优先权。
Rugaard\GitHooks\PHP\Hooks\PreCommit\PhpLintCommand
检查所有暂存的 .php
文件中的语法错误。
脚本无需配置
Rugaard\GitHooks\PHP\Hooks\PreCommit\PhpStaticAnalysisCommand
静态分析所有(或暂存的).php
文件中的错误。
注意:默认情况下,如果没有提供有效的 config
,此命令将寻找 phpstan.neon
或 phpstan.neon.dist
作为替代。
如果找到这些选项中的任何一个,上述参数将被忽略,配置文件将具有优先权。
Rugaard\GitHooks\PHP\Hooks\PrePush\PhpTestSuiteCommand
运行项目的测试套件。
* 需要在您的项目中安装 pest
注意:默认情况下,如果没有提供有效的 config
,此命令将寻找 phpunit.xml
或 phpunit.xml.dist
作为替代。
如果找到这些选项中的任何一个,上述参数将被忽略,配置文件将具有优先权。
🚓 许可证
此软件包受MIT 许可。