zieglerh / php-code-quality
用于运行PHP 8.x代码检查的CLI工具,适用于Pimcore 11
v1.0
2024-03-10 20:11 UTC
Requires
- phpmd/phpmd: 2.13.0
- phpstan/phpstan: ^1.10
- phpstan/phpstan-symfony: ^1.3
- rector/rector: ^1.0
- squizlabs/php_codesniffer: ^3.6
- symplify/phpstan-rules: ^12.4
README
用于运行PHP代码检查和重构Pimcore的CLI工具
安装
Composer
composer require --dev zieglerh/php-code-quality:^1.0
模板
将 /templates/*
复制到您的项目根目录
覆盖规则集
在您的 .env
文件中,您可以定义一个路径来覆盖规则集,例如从项目根目录开始
PHPCS_RULESET_FILE=./phpcs.xml
PHPMD_RULESET_FILE=./phpmd.xml
禁用工具
您可以通过在 .env
文件中设置以下内容来禁用工具
PHPCS=0
PHPMD=0
PHPSTAN=0
或者禁用所有工具
CODE_CHECKS_ENABLED=0
覆盖工具参数
您还可以通过在 .env
文件中覆盖 definition_args.conf
中的工具参数
PHPCS_ARGS=...
PHPMD_ARGS=...
PHPSTAN_ARGS=...
执行
代码检查
vendor/bin/code-check
要执行特定工具,您可以附加一个或多个参数
vendor/bin/code-check phpcs phpmd phpstan
自动重构
显示自动代码重构
vendor/bin/rector process --dry-run
运行rector并更改所有文件
vendor/bin/rector process
配置规则集
配置
有关工具配置,请参阅 defnitions_tools.conf
规则集
规则集在 rulesets/*.xml 文件中定义,并可被覆盖
有关覆盖规则集的说明,请参阅 覆盖规则集