PHPStan Strict Rules 使用指南

PHPStan Strict Rules 使用指南

phpstan-strict-rulesExtra strict and opinionated rules for PHPStan项目地址:https://gitcode.com/gh_mirrors/ph/phpstan-strict-rules

项目目录结构及介绍

PHPStan Strict Rules 是一个旨在增强 PHPStan 静态分析体验的扩展包，它通过添加基于最佳实践的额外严格规则来提升代码质量。以下是项目的基本目录结构及关键组件说明：

phpstan-strict-rules/
├── composer.json           # 项目元数据和依赖管理文件
├── src                     # 核心规则实现代码所在目录
│   └── Rule               # 包含所有自定义规则类的子目录
├── tests                   # 单元测试和示例代码目录
│   ├── Rule               # 规则相关的测试
│   └── ...                # 其他测试相关文件或目录
├── README.md               # 项目简介和快速入门文档
├── CHANGELOG.md            # 版本更新日志
├── phpstan.neon.dist       # 预设的PHPStan配置文件
└── ...

• composer.json：包含了项目的依赖和元数据，用于通过Composer管理依赖。
• src/Rules：存放了所有的自定义规则类，这些规则是Strict Rules的核心。
• tests：提供了对所有规则进行测试的环境，确保规则的有效性。
• phpstan.neon.dist：是一个预置的PHPStan配置模板，包含了Strict Rules的默认配置。

项目的启动文件介绍

在本项目中，并没有传统意义上的“启动文件”，因为这是一个库而非独立应用。其“启动”过程实际上是指集成到你的PHP项目中的步骤。这通常涉及到在你的项目中通过Composer添加依赖，并配置PHPStan以使用这些严格规则。

添加依赖

在你的项目根目录下运行以下命令将PHPStan Strict Rules添加为依赖：

composer require --dev phpstan/phpstan-strict-rules

配置PHPStan

接着，在你的PHPStan配置文件（通常是.phpstan.neon或.phpstan.neon.dist）中引入此扩展：

includes:
    - vendor/phpstan/phpstan-strict-rules/rules.neon

项目的配置文件介绍

PHPStan Strict Rules配置

虽然本项目本身不直接提供一个“启动文件”，它的核心配置主要通过修改你的PHPStan配置来体现。你可以通过修改或创建配置参数来控制哪些规则被启用或禁用。

• 禁用规则:

  在PHPStan的配置文件中，可以通过指定strictRules节来控制每个规则的状态，如：

  parameters:
      strictRules:
          disallowedLooseComparison: false
  

• 逐个启用规则:

  若只想启用部分规则而不全部采用，可以先关闭所有规则然后单独启用所需规则：

  parameters:
      strictRules:
          allRules: false
          booleansInConditions: true
  

配置文件允许高度定制，确保规则符合你项目的具体需求，从而加强代码的质量检查，而不会带来不必要的开发障碍。

通过以上步骤，你就能成功集成并定制PHPStan Strict Rules到你的PHP项目中，享受更高级别的代码静态分析。

phpstan-strict-rulesExtra strict and opinionated rules for PHPStan项目地址:https://gitcode.com/gh_mirrors/ph/phpstan-strict-rules