README

此 composer 包将使用 https://github.com/phpro/grumphp 在提交代码之前提供一些基本的代码质量检查。

它仅检查 git 提交中修改的文件或新文件，但可以通过运行 vendor/bin/grumphp run 在所有配置的路径上执行检查。

此工具仅扩展 GrumPHP。请阅读其文档了解如何配置工具本身。

执行检查

此存储库目前有以下检查

Shell 脚本执行位 - check_file_permissions
PHP Drupal CS 和 PHP 代码安全 - phpcs
PHP 8.1 兼容性 - php_compatibility
PHP 语法 - php_check_syntax
认知复杂度和其他 ecs sniffs - ecs
Yaml 语法 - yaml_lint
Json 语法 - json_lint
弃用测试 - php_stan

先决条件

Composer
PHP >= 8.1

安装

这只需要在创建项目或启用现有项目的代码检查时进行一次。

composer require wunderio/code-quality --dev
cp vendor/wunderio/code-quality/config/grumphp.yml ./grumphp.yml
cp vendor/wunderio/code-quality/config/phpstan.neon ./phpstan.neon
cp vendor/wunderio/code-quality/config/psalm.xml ./psalm.xml

GrumPHP 的提交钩子将在 composer require 时自动安装。

自定义

配置

配置的详细信息分为以下部分。

参数 – GrumPHP 本身的配置设置。
任务 – 执行代码验证的外部任务及其相应的配置。
测试套件
扩展
事件
约定检查器

任务参数

如果您需要自定义 PHP CodeSniffer 的规则，请将 phpcs.xml 放入与 composer.json 相同的文件夹中，并配置 grumphp.yml

parameters:
  tasks:
    phpcs:
      standard:
        - phpcs.xml

同样适用于使用其他配置文件（easy-coding-standards）的任何任务。

每个代码质量工具都允许您定义至少 3 件事

run_on - 将进行检查的多条路径，待处理的文件必须来自相同的路径
ignore_patterns - 将排除文件检查的路径部分
extensions - 应该检查的文件的文件扩展名

有关其他可配置选项的更多信息，请参阅各个任务的文档。

命令

由于 GrumPHP 只是一个 CLI 工具，因此可以触发以下命令

使用方法

在执行 git commit 命令时，pre-commit 挂钩将自动运行。

可以通过 git commit --no-verify 或 git commit -n 来跳过代码扫描，但这种情况仅适用于极少数情况。

您可以通过以下命令手动运行检查：./vendor/bin/grumphp run

要从 grumphp.yml 中定义的任务中运行特定任务，您可以使用 --tasks 参数进行定义。示例

./vendor/bin/grumphp run --tasks=phpcs

在持续集成中的使用

您可以通过在 CI（CircleCi/Jenkins/GitLab CI）中添加以下行来轻松使用代码质量检查器：

./vendor/bin/grumphp run --no-ansi --no-interaction

wunderio / code-quality

维护者

详细信息