fivejars/drupal-quality-check

为FiveJars Drupal项目设置代码质量检查工具。

dev-master 2024-04-16 11:00 UTC

This package is auto-updated.

Last update: 2024-09-19 08:16:59 UTC


README

概览

提供了一套库,可以轻松地为Drupal项目设置基于GrumPHP的代码质量检查。

安装

  1. 使用Composer添加此包:composer require --dev fivejars/drupal-quality-check
  2. 将配置文件(grumphp.yml.distphpmd.xml.distphpstan.neon.dist)复制到项目根目录(不是Drupal根目录),不要包含.dist后缀(grumphp.ymlphpmd.xmlphpstan.neon)。
  3. 根据项目要求概览和更改配置。
  4. composer.scripts.json中的脚本部分复制到项目的composer.json中,或者使用wikimedia/composer-merge-plugin进行合并。

这就完成了。现在,每当进行git commit时,都会运行GrumPHP任务。您还可以使用Composer脚本运行其他任务。

注意: 作为安装的一部分,GrumPHP会将pre-commit钩子添加到仓库中。在安装/卸载时,现有的pre-commit可能会被销毁

Composer脚本

  1. composer grumphp - 运行GrumPHP处理已添加到Git的项目文件
  2. composer phpmetrics - 从配置的目录生成项目文件的PHP度量(请参阅包根目录中的composer.scripts.json
  3. composer phpstan - 运行PHPStan处理配置目录中的项目文件(请参阅项目根目录中的phpstan.neon
  4. composer phpcs YOUR_DIR - 在从命令行参数提供的目录上运行PHPCS
  5. composer phpcbf YOUR_DIR - 在从命令行参数提供的目录上运行PHPCBF
  6. composer phpmd - 运行PHPMD处理配置目录中的项目文件(请参阅项目根目录中的phpmd.xml
  7. composer phpmnd - 运行PHPMD处理配置目录中的项目文件(请参阅包根目录中的composer.scripts.json
  8. composer twigcs YOUR_DIR - 在从命令行参数提供的目录上运行TwigCS

功能

  1. PHPCS(Drupal标准)
  2. PHP Lint
  3. YAML Lint
  4. Composer
  5. Composer Normalize
  6. JSONLint
  7. PHP Copy/Paste Detector (CPD)
  8. PHPStan
  9. TwigCS
  10. PHPCompatibility
  11. PHPMetrics

更长的检查/验证列表请见此处