Laravel Pint 中如何正确禁用 PHP 文档对齐规则

问题背景

在 Laravel Pint 1.14 版本中，许多开发者遇到了无法禁用 Laravel 自定义规则的问题，特别是关于 PHP 文档注释对齐的规则。当尝试在 pint.json 配置文件中禁用 Laravel/laravel_phpdoc_alignment 规则时，系统会提示该修复器未知的警告信息。

问题原因

这个问题的根源在于 Laravel Pint 在 1.13.9 版本中进行了重要更新，移除了自定义的 Laravel 修复器，转而使用 PHP-CS-Fixer 原生的 phpdoc_align 规则。这一变更使得之前使用的 Laravel/laravel_phpdoc_alignment 规则标识符失效。

解决方案

要正确配置 PHP 文档注释的对齐规则，现在应该使用标准的 phpdoc_align 规则名称。以下是推荐的配置方式：

{
    "preset": "laravel",
    "rules": {
        "phpdoc_align": false
    }
}

如果你想保留文档对齐功能但调整其行为，可以将值设为 true 或使用更详细的配置选项。

技术细节

1. 规则变更历史：

   • 旧版使用自定义规则 Laravel/laravel_phpdoc_alignment
   • 1.13.9 版本后改用 PHP-CS-Fixer 原生规则 phpdoc_align

2. 配置选项：

   • false：完全禁用文档注释对齐
   • true：启用默认对齐行为
   • 也可以传递配置数组进行更精细的控制

3. 兼容性考虑：

   • 新配置同时兼容新旧版本
   • 旧的自定义规则名称将不再有效

最佳实践建议

1. 升级到最新版本后，检查并更新 pint.json 配置文件
2. 使用 phpdoc_align 替代旧的规则名称
3. 可以利用这个机会重新评估项目的代码风格需求
4. 对于团队项目，确保所有成员同步更新配置

总结

Laravel Pint 的这次规则变更体现了项目向标准化靠拢的趋势，使用 PHP-CS-Fixer 原生规则能带来更好的兼容性和维护性。开发者应及时更新配置，采用新的规则名称，以确保代码格式化工具的正常工作。