开发工具代码质量静态分析Lint格式化【免费下载链接】PHP-CS-FixerA tool to automatically fix PHP Coding Standards issues项目地址https://gitcode.com/gh_mirrors/ph/PHP-CS-Fixer点击查看免费下载PHPUnit100Migration:risky是 PHP-CS-Fixer 内置的迁移规则集用于自动改进测试代码以兼容 PHPUnit 10.0。本文基于 PHPUnit100MigrationRisky.rst 展开结合仓库源码说明其废弃状态、命名迁移机制100→10x0、风险等级判定规则以及实际使用PHPUnit10x0Migration:risky时应了解的规则构成与配置要点。规则集定位为 PHPUnit 10.0 准备测试代码PHPUnit100Migration:risky的核心使命非常明确——改进测试代码以兼容 PHPUnit 10.0。它是 PHP-CS-Fixer 众多迁移规则集Migration Rule Set中的一员与PHPUnit9x1Migration:risky、PHPUnit10x0Migration:risky、PHPUnit11x0Migration:risky等组成一套面向 PHPUnit 各版本升级的规则集家族。从仓库源码可以印证这一点。AbstractMigrationSetDefinition.php 中的getDescription()方法会根据规则集名称自动生成描述其内部为PHPUnit实体预设了tests code测试代码作为改进对象最终拼接出Rules to improve tests code for PHPUnit 10.0 compatibility.这样的描述文案——这正是该规则集文档第一句话的源码出处。重要警告该规则集已废弃将在 4.0 移除这是阅读本规则集文档时最先需要掌握的信息PHPUnit100Migration:risky已被标记为 DEPRECATED并将在下一个大版本4.0中被移除。官方给出的替代方案是You should usePHPUnit10x0Migration:riskyinstead.也就是说如果你正在编写新的配置文件或维护现有配置不要直接使用PHPUnit100Migration:risky而应改用PHPUnit10x0Migration:risky。前者保留在当前版本中仅仅是为了向后兼容属于过渡性存在。源码层面的废弃机制废弃并非仅仅停留在文档层面源码实现完整支撑了这一设计。规则集类 PHPUnit100MigrationRiskySet.php 本身是一个空类继承自AbstractMajorMinorDeprecationSetDefinition后者在 AbstractMajorMinorDeprecationSetDefinition.php 中实现了废弃规则集的核心逻辑public function getRules(): array { $newName Preg::replace(#(\d)\.?(\d)#, \1x\2, $this-getName()); return [ $newName true, ]; } public function getSuccessorsNames(): array { return array_keys($this-getRules()); }这段代码揭示了两层关键事实废弃规则集是转发器getRules()返回的并不是具体的 fixer 规则列表而是把自身名称经过正则转换后指向新规则集。对PHPUnit100Migration:risky而言正则#(\d)\.?(\d)#会把名称中的100转换为10x0最终得到[PHPUnit10x0Migration:risky true]——即使用我等同于使用新的PHPUnit10x0Migration:risky。后继者名称机制getSuccessorsNames()返回替代规则集的名称配合 DeprecatedRuleSetDefinitionInterface.php 定义的getSuccessorsNames(): array契约让工具链如 CLI 的警告检测、文档生成器能够向用户明确提示应当改用哪个新规则集。类名到规则集名的转换由 AbstractRuleSetDefinition.php 完成取类名去掉命名空间与Set后缀再把Risky替换为:risky于是PHPUnit100MigrationRiskySet就变成了PHPUnit100Migration:risky。x 命名约定的来由10x0这种带x的命名并非随意为之。从 AbstractMigrationSetDefinition.php 的parseRuleSetName()可以看到规则集名称通过正则#^PHPUnit(\d)x?(\d)Migration.*$#解析出实体PHPUnit与主/次版本号major10, minor0。x表示该规则集面向该主版本全系列10.x 的所有次版本相比精确到次版本的100命名10x0的语义更宽泛、更具长期适用性。源码中的TODO v4注释也表明当前保留x?的可选匹配正是为了兼容这种新旧命名并存的过渡期。风险提示这是 RISKY 规则集与普通规则集不同PHPUnit100Migration:risky及其后继者PHPUnit10x0Migration:risky属于高风险RISKY规则集。文档明确警告This set contains rules that are risky. Using it may lead to changes in your codes logic and behaviour. Use it with caution and review changes before incorporating them into your code base.风险规则集意味着其中的 fixer 可能改变代码的逻辑与行为而非仅仅调整格式。因此必须在配置中显式开启且通常需要配合--allow-riskyyes或在配置中设置risky true的规则时显式允许才会生效使用前应充分理解每条规则的具体行为合并前务必人工审查 diff从源码看AbstractRuleSetDefinition.php 的isRisky()方法以类名是否包含Risky判定规则集风险属性机制简单直接。替换规则集的实际构成PHPUnit10x0Migration:risky既然官方建议改用PHPUnit10x0Migration:risky那么了解它实际包含哪些规则就至关重要。在 PHPUnit10x0MigrationRiskySet.php 中可以看到其完整的规则清单public function getRules(): array { return [ PHPUnit9x1Migration:risky true, php_unit_data_provider_static [force true], ]; }即该规则集包含两部分PHPUnit9x1Migration:risky嵌套引用的另一个迁移规则集负责从 PHPUnit 9.1 迁移过来的相关修复php_unit_data_provider_static配置[force true]将数据提供者方法强制改为static。核心规则详解php_unit_data_provider_staticphp_unit_data_provider_static是本规则集唯一的独立 fixer 规则详细文档见 php_unit_data_provider_static.rst其对应实现为 PhpUnitDataProviderStaticFixer.php测试类为 PhpUnitDataProviderStaticFixerTest.php。规则作用数据提供者Data Provider方法必须是static的。这是 PHPUnit 10 的硬性要求之一从 PHPUnit 10 开始非静态的 data provider 将触发弃用警告直至报错因此迁移到 PHPUnit 10 前必须把所有dataProvider引用的方法改为静态方法。可配置项force配置项类型默认值说明forceboolfalse是否强制将数据提供者改为静态即使其内部存在动态类调用如$this-...force false默认仅当方法体不依赖$this可以安全静态化时才添加static关键字避免引入运行时错误force true无条件添加static关键字。文档特别警告这可能引入致命错误using $this when not in object context你需要手动把方法体内的动态调用$this-method()改为静态调用self::method()。配置示例对比默认配置仅安全场景转换?php class FooTest extends TestCase { /** * dataProvider provideSomethingCases */ public function testSomething($expected, $actual) {} - public function provideSomethingCases() {} public static function provideSomethingCases() {} }[force true]无条件转换含$this的方法也会被加static?php class FooTest extends TestCase { /** * dataProvider provideSomethingCases1 * dataProvider provideSomethingCases2 */ public function testSomething($expected, $actual) {} - public function provideSomethingCases1() { $this-getData1(); } - public function provideSomethingCases2() { self::getData2(); } public static function provideSomethingCases1() { $this-getData1(); } public static function provideSomethingCases2() { self::getData2(); } }注意第一个方法在force true下虽然被加上了static但内部的$this-getData1()会在运行时触发致命错误这正是必须人工审查并手动修复的风险来源。[force false]跳过含$this的方法?php class FooTest extends TestCase { /** * dataProvider provideSomething1Cases * dataProvider provideSomething2Cases */ public function testSomething($expected, $actual) {} public function provideSomething1Cases() { $this-getData1(); } - public function provideSomething2Cases() { self::getData2(); } public static function provideSomething2Cases() { self::getData2(); } }为何在迁移规则集中默认force true从 php_unit_data_provider_static.rst 的 Rule sets 一节可以看到force true的强配置同时被PhpCsFixer:risky、PHPUnit10x0Migration:risky、PHPUnit11x0Migration:risky以及已废弃的PHPUnit100Migration:risky采用。原因在于PHPUnit 10 要求 data provider 必须静态若不强制转换含有$this的方法将无法通过 PHPUnit 10 的运行校验强制转换虽然可能引发瞬时错误但能保证一次性暴露所有需要手工修复的点从而推动彻底完成迁移。如何在实际项目中应用虽然PHPUnit100Migration:risky已废弃但理解它的用法依然有现实意义——你可以把同样的配置方式迁移到新规则集上。在.php-cs-fixer.php配置文件中启用该迁移?php $finder PhpCsFixer\Finder::create() -in(__DIR__./tests); return (new PhpCsFixer\Config()) -setRiskyAllowed(true) // 必须允许 risky 规则 -setRules([ PHPUnit10x0Migration:risky true, ]) -setFinder($finder);要点总结必须setRiskyAllowed(true)或 CLI 加--allow-riskyyes否则包含 risky 规则的规则集不会生效不要在新配置中写PHPUnit100Migration:risky直接使用PHPUnit10x0Migration:risky若旧配置仍引用前者CLI 会基于getSuccessorsNames()给出弃用提示运行前先备份或用版本控制确认改动因为php_unit_data_provider_static在force true下可能生成暂不能运行的代码$this调用需人工将动态调用改为self::静态调用迁移完成后建议结合 PHPUnit 10 实际运行测试套件验证而非只依赖格式检查。关联资源索引规则集文档doc/ruleSets/PHPUnit100MigrationRisky.rst、后继者文档 doc/ruleSets/PHPUnit10x0MigrationRisky.rst废弃转发实现src/RuleSet/AbstractMajorMinorDeprecationSetDefinition.php新规则集定义src/RuleSet/Sets/PHPUnit10x0MigrationRiskySet.php规则详情doc/rules/php_unit/php_unit_data_provider_static.rstFixer 实现与测试src/Fixer/PhpUnit/PhpUnitDataProviderStaticFixer.php、tests/Fixer/PhpUnit/PhpUnitDataProviderStaticFixerTest.php总而言之PHPUnit100Migration:risky是 PHP-CS-Fixer 面向 PHPUnit 10.0 迁移的历史性规则集其文档价值在于既说明了已废弃、改用PHPUnit10x0Migration:risky这一关键事实也通过源码揭示了废弃规则集如何借助AbstractMajorMinorDeprecationSetDefinition实现向后兼容的转发机制并展示了 risky 迁移规则集在提升兼容性的同时所伴随的行为变更风险。赞分享开发工具代码质量静态分析Lint格式化【免费下载链接】PHP-CS-FixerA tool to automatically fix PHP Coding Standards issues项目地址https://gitcode.com/gh_mirrors/ph/PHP-CS-Fixer点击查看免费下载相关推荐PHP-CS-Fixer 规则集 PHP70MigrationPHP 7.0 兼容性规则与废弃迁移指南PHP CS Fixer 规则集 PHP70Migration PHP 7.0 兼容性规则与废弃迁移指南 PHP70Migration 是 PHP CS开发工具代码质量静态分析Lint格式化PHP-CS-Fixer 规则集解析PHPUnit52Migration:risky 的废弃演进与 PHPUnit 5.2 测试代码迁移实战PHP CS Fixer 规则集解析 PHPUnit52Migration:risky 的废弃演进与 PHPUnit 5.2 测试代码迁移实战 PHPUn开发工具代码质量静态分析Lint格式化PHP-CS-Fixer 的 PHP74Migration 规则集从废弃命名到 PHP7x4Migration 的 PHP 7.4 兼容性迁移实战PHP CS Fixer 的 PHP74Migration 规则集从废弃命名到 PHP7x4Migration 的 PHP 7.4 兼容性迁移实战 导读开发工具代码质量静态分析Lint格式化创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考