PHPStan Bodyscan 使用教程

1. 项目介绍

PHPStan Bodyscan 是一个开源工具，用于分析 PHP 项目代码质量，并提供每个 PHPStan 级别的错误计数。通过该工具，开发者可以快速了解项目的代码质量，并决定最适合项目的 PHPStan 级别。

2. 项目快速启动

首先，确保您的环境中已经安装了 Composer。

安装

在项目根目录下运行以下命令：

composer require tomasvotruba/phpstan-bodyscan --dev

使用

安装完成后，执行以下命令以运行工具：

vendor/bin/phpstan-bodyscan

该命令将执行完整的 PHPStan 分析，可能会花费一些时间。分析完成后，它会显示每个级别的错误计数。

如果您需要限制分析级别，可以使用以下命令：

vendor/bin/phpstan-bodyscan run --min-level 0 --max-level 3

如果您想以 JSON 格式输出错误计数，可以使用：

vendor/bin/phpstan-bodyscan --json

3. 应用案例和最佳实践

应用案例

• 评估新接手项目的代码质量。
• 在项目开发周期中，监控代码质量的变化。
• 在代码重构前后，对比错误计数，评估重构效果。

最佳实践

• 定期运行 PHPStan Bodyscan，以监控代码质量。
• 根据错误计数，逐步提升 PHPStan 分析级别，以达到更高的代码质量标准。
• 利用 --json 输出，将结果集成到自动化测试流程中。

4. 典型生态项目

PHPStan Bodyscan 可以与以下生态项目配合使用，以提高 PHP 项目开发效率：

• PHPStan：PHP 静态分析工具，用于发现潜在错误。
• Rector：用于自动重构 PHP 代码的工具。
• PHPUnit：PHP 单元测试框架。

通过整合这些工具，可以构建一个强大的 PHP 开发和测试环境。