fivejars / drupal-quality-check
为FiveJars Drupal项目设置代码质量检查工具。
dev-master
2024-04-16 11:00 UTC
Requires
- php: >=8.2
- acquia/coding-standards: ^2.0
- dealerdirect/phpcodesniffer-composer-installer: *
- drupal/coder: 8.3.23
- ergebnis/composer-normalize: >=2.5
- ergebnis/phpstan-rules: ^2.1
- friendsoftwig/twigcs: ^6.4
- mglaman/phpstan-drupal: ^1.1
- php-parallel-lint/php-parallel-lint: ^1.3
- phpcompatibility/php-compatibility: ^9.3
- phpmd/phpmd: ^2.15
- phpmetrics/phpmetrics: ^3.0@rc
- phpro/grumphp-shim: ^2.3
- phpstan/extension-installer: ^1.3
- phpstan/phpstan: ^1.10
- povils/phpmnd: ^3.3
- sebastian/phpcpd: >=4.0
- squizlabs/php_codesniffer: ^3.8
This package is auto-updated.
Last update: 2024-09-19 08:16:59 UTC
README
概览
提供了一套库,可以轻松地为Drupal项目设置基于GrumPHP的代码质量检查。
安装
- 使用Composer添加此包:
composer require --dev fivejars/drupal-quality-check
- 将配置文件(
grumphp.yml.dist
、phpmd.xml.dist
、phpstan.neon.dist
)复制到项目根目录(不是Drupal根目录),不要包含.dist
后缀(grumphp.yml
、phpmd.xml
、phpstan.neon
)。 - 根据项目要求概览和更改配置。
- 将
composer.scripts.json
中的脚本部分复制到项目的composer.json
中,或者使用wikimedia/composer-merge-plugin
进行合并。
这就完成了。现在,每当进行git commit
时,都会运行GrumPHP任务。您还可以使用Composer脚本运行其他任务。
注意: 作为安装的一部分,GrumPHP会将
pre-commit
钩子添加到仓库中。在安装/卸载时,现有的pre-commit
可能会被销毁。
Composer脚本
composer grumphp
- 运行GrumPHP处理已添加到Git的项目文件composer phpmetrics
- 从配置的目录生成项目文件的PHP度量(请参阅包根目录中的composer.scripts.json
)composer phpstan
- 运行PHPStan处理配置目录中的项目文件(请参阅项目根目录中的phpstan.neon
)composer phpcs YOUR_DIR
- 在从命令行参数提供的目录上运行PHPCScomposer phpcbf YOUR_DIR
- 在从命令行参数提供的目录上运行PHPCBFcomposer phpmd
- 运行PHPMD处理配置目录中的项目文件(请参阅项目根目录中的phpmd.xml
)composer phpmnd
- 运行PHPMD处理配置目录中的项目文件(请参阅包根目录中的composer.scripts.json
)composer twigcs YOUR_DIR
- 在从命令行参数提供的目录上运行TwigCS
功能
- PHPCS(Drupal标准)
- PHP Lint
- YAML Lint
- Composer
- Composer Normalize
- JSONLint
- PHP Copy/Paste Detector (CPD)
- PHPStan
- TwigCS
- PHPCompatibility
- PHPMetrics
更长的检查/验证列表请见此处。