Laravel Pint 中排除目录不生效的问题解析

问题现象

在使用 Laravel Pint 代码格式化工具时，许多开发者会遇到一个常见问题：在 pint.json 配置文件中设置了 exclude 排除目录后，当直接指定路径运行 Pint 时，排除规则似乎不起作用。

问题重现

开发者通常会这样配置 pint.json：

{
    "preset": "laravel",
    "exclude": [
        "bootstrap/cache",
        "bootstrap/cache/*",
        "bootstrap/cache/*.php"
    ]
}

然后运行命令：

./vendor/bin/pint bootstrap

结果发现 Pint 仍然会扫描并格式化 bootstrap/cache 目录下的文件，这与预期不符。

问题根源

这个问题实际上源于底层依赖的 PHP-CS-Fixer 的工作机制。当 Pint 运行时指定了具体路径参数时，PHP-CS-Fixer 会忽略配置文件中的 exclude 排除规则。这是 PHP-CS-Fixer 的预期行为，而非 Pint 本身的 bug。

解决方案

要正确使用排除功能，开发者应该：

1. 不指定路径运行 Pint：

./vendor/bin/pint

这样 Pint 会读取整个项目目录，并正确应用 pint.json 中的排除规则。

2. 如果确实需要指定路径： 可以考虑使用更精确的路径参数，避开需要排除的目录，或者编写自定义脚本来实现更复杂的排除逻辑。

最佳实践建议

1. 在大多数情况下，直接运行 Pint 而不指定路径是最佳选择，因为它会尊重配置文件中的所有规则。

2. 对于大型项目，如果担心全项目扫描耗时过长，可以考虑：

   • 使用 Git 钩子只检查修改的文件
   • 设置 CI/CD 流程时运行完整检查
   • 开发时使用 IDE 的实时格式化功能

3. 了解 Laravel Pint 默认已经排除了 bootstrap/cache 目录，除非特别需要，一般不需要在配置中重复声明。

技术背景

Laravel Pint 底层使用 PHP-CS-Fixer 实现代码格式化功能。PHP-CS-Fixer 在设计时认为，当用户显式指定要检查的路径时，就应该检查该路径下的所有内容，因此会忽略排除规则。这种设计理念认为显式指定的路径优先级高于配置文件中的排除规则。

理解这一机制后，开发者就能更好地规划自己的代码检查策略，避免陷入配置无效的困惑。