README

建立在 PHPStan 之上，这个静态分析工具将检查正确性（例如使用不存在的类），弃用错误以及其他更多内容。

为什么？虽然现在有许多静态分析工具，但它们都没有考虑到 Drupal 的上下文。这允许检查由核心抛出的弃用错误。

你准备好迎接 Drupal 9 了吗？查看我们的 Drupal 9 准备情况指令，了解此工具如何帮助。

赞助商

你想赞助吗？

需求

PHP >=7.2

安装

您可以使用 Composer 将此作为开发依赖项安装到您的项目中，如下所示

composer require mglaman/drupal-check --dev

您还可以使用 Composer 全局安装此工具，如下所示

composer global require mglaman/drupal-check

有关如何确保全局二进制文件在您的 PATH 中的信息，请参阅 Composer 的文档：https://getcomposer.org.cn/doc/00-intro.md#manual-installation。

用法

php vendor/bin/drupal-check [options] [--] <path>...

参数

path - 要检查的 Drupal 代码路径

选项

--drupal-root[=DRUPAL-ROOT] - Drupal 根路径。
--format[=FORMAT] - 要使用的格式化程序：raw、table、checkstyle、json 或 junit [默认: "table"]
-d, --deprecations - 检查弃用
-a, --analysis - 检查代码分析
-s, --style - 检查代码风格
--php8 - 设置 PHPStan 的 phpVersion 为 8.1（Drupal 10 要求）
--memory-limit[=MEMORY-LIMIT] - 分析的内存限制
-e, --exclude-dir[=EXCLUDE-DIR] - 要排除的目录。使用逗号分隔多个目录，不要有空格。
--no-progress - 不显示进度条，只显示结果
-h, --help - 显示此帮助信息
-q, --quiet - 不输出任何消息
-V, --version - 显示此应用程序版本
--ansi - 强制 ANSI 输出
--no-ansi - 禁用 ANSI 输出
-n, --no-interaction - 不要询问任何交互式问题
-v|vv|vvv, --verbose - 增加消息的详细程度：1 为正常输出，2 为更详细的输出，3 为调试

示例

检查地址 contrib 模块

php vendor/bin/drupal-check web/modules/contrib/address

检查地址 contrib 模块中的弃用

php vendor/bin/drupal-check -d web/modules/contrib/address

检查地址 contrib 模块中的分析

php vendor/bin/drupal-check -a web/modules/contrib/address

将 PHPStan 更新回 2 级以进行弃用分析

drupal-check:1.4.0 将 PHPStan 的分析级别设置为 2 以进行弃用，并设置为 6 以进行分析。这确保了基本分析错误得到修复，以提供最佳弃用代码检测体验。您可以在此处了解更多关于 PHPStan 规则级别的信息：https://phpstan.org/user-guide/rule-levels

如果您不想在 2 级运行 PHPStan 并且只想报告弃用消息，请按照以下说明操作

composer remove mglaman/drupal-check
composer require  --dev phpstan/phpstan \
  phpstan/extension-installer \
  mglaman/phpstan-drupal \
  phpstan/phpstan-deprecation-rules

创建一个 phpstan.neon 文件，内容如下

parameters:
	customRulesetUsed: true
	ignoreErrors:
		- '#\Drupal calls should be avoided in classes, use dependency injection instead#'
		- '#Plugin definitions cannot be altered.#'
		- '#Missing cache backend declaration for performance.#'
		- '#Plugin manager has cache backend specified but does not declare cache tags.#'

	# FROM mglaman/drupal-check/phpstan/base_config.neon
	reportUnmatchedIgnoredErrors: false
	excludePaths:
		- */tests/Drupal/Tests/Listeners/Legacy/*
		- */tests/fixtures/*.php
		- */settings*.php
		- */bower_components/*
		- */node_modules/*