PHPStan Bodyscan 项目使用教程

1. 项目的目录结构及介绍

PHPStan Bodyscan 项目的主要目录结构如下：

phpstan-bodyscan/
├── .github/                # GitHub 工作流和配置文件
├── bin/                    # 执行脚本
├── build/                  # 构建脚本
├── src/                    # 源代码目录
├── tests/                  # 测试目录
├── .editorconfig            # 编辑器配置文件
├── .gitattributes           # Git 属性文件
├── .gitignore              # Git 忽略文件
├── LICENSE                 # 项目许可证文件
├── README.md               # 项目说明文件
├── composer.json           # Composer 配置文件
├── ecs.php                 # EasyCodingStandard 配置文件
├── full-tool-build.sh      # 完整工具构建脚本
├── phpstan-bodyscan.neon   # PHPStan 配置文件
├── phpstan.neon            # PHPStan 配置文件
├── phpunit.xml             # PHPUnit 配置文件
├── prefix-code.sh          # 前置代码脚本
├── rector.php              # Rector 配置文件
├── scoper.php              # Scoper 配置文件

• src/ 目录包含项目的核心代码。
• tests/ 目录包含单元测试和集成测试代码。
• .github/ 目录包含 GitHub Actions 工作流文件，用于自动化测试、构建等。
• bin/ 目录包含用于运行项目的脚本。

2. 项目的启动文件介绍

项目的启动主要通过 bin/phpstan-bodyscan 脚本。运行该脚本会启动 PHPStan Bodyscan 工具，对项目代码进行静态分析，并输出不同 PHPStan 级别的错误数量。

启动命令如下：

vendor/bin/phpstan-bodyscan

此外，还可以使用以下选项：

• --bare：不加载任何 PHPStan 扩展。
• --json：以 JSON 格式输出结果。
• --min-level 和 --max-level：指定要分析的 PHPStan 级别范围。
• --env-file：指定环境变量文件，用于加载额外的配置。

3. 项目的配置文件介绍

项目的配置文件主要包括以下几个：

• composer.json：定义项目依赖、自动加载规则等。
• phpstan-bodyscan.neon 和 phpstan.neon：PHPStan 配置文件，用于定义静态分析规则和级别。
• .editorconfig：定义编辑器配置，以保持代码风格的一致性。
• phpunit.xml：PHPUnit 配置文件，用于定义单元测试的设置。

phpstan.neon 配置文件示例：

includes:
    - vendor/phpstan/phpstan/conf/bleedingEdge.neon
parameters:
    level: max
    paths:
        - src
    ignoreErrors:
        - '#PHPDoc tag @var for variable \$a contains unknown class#'

以上配置文件定义了 PHPStan 的最高分析级别，并指定了要分析的源代码路径以及要忽略的错误。