judapriest/drupal-quality-checker

这是一个从vijaycs85/drupal-quality-checker分支出来的版本,专门针对Ecedi启动套件和分发。为Drupal项目设置代码质量检查工具。

1.2.1 2020-05-17 18:07 UTC

This package is auto-updated.

Last update: 2024-09-18 03:42:57 UTC


README

概览

提供一套库,便于基于GrumPHP为Drupal模块/主题/配置文件设置代码质量检查。

注意: 此库旨在帮助ecedi启动套件和分发。

安装

  1. judapriest/drupal-quality-checker添加到composer.json文件中: composer require --dev judapriest/drupal-quality-checker
  2. 将项目根目录(非Drupal根目录)中的grumphp.yml替换为vendor/judapriest/drupal-quality-checker/grumphp.yml.dist

完成。现在,所有任务(如下所示)将在每次git commit时运行。

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

功能

  1. 基于Drupal标准的PHPCS
  2. PHPLint
  3. YAML Lint
  4. Composer
  5. JSONLint
  6. PHP Copy/Paste Detector (CPD)
  7. Composer Normalizer

更多检查/验证器列表请见此处

如何使用

预配置

安装后(见#安装),它会配置为在每次git commit时运行。它将仅分析您要提交的文件。

独立运行

您也可以从根目录使用bin/grumphp run来分析所有现有文件(除了在grumphp.yml文件中定义的排除或忽略文件)。

示例

通过

drupal-quality-checker-pass

失败

drupal-quality-checker-fail

演示

Modal Configuration模块中实现。

卸载

  1. 您可以使用composer remove judapriest/drupal-quality-checker --update-with-dependencies来移除此包。
  2. 如果存在,请从项目根目录中移除grumphp.yml
  3. 如有必要,修改.git/hooks/pre-commit.git/hooks/commit-msg