PHPCS 对文件类型的限制

Question

我正在尝试为特定框架“指南”创建自定义规则集。但是，我希望能够将嗅探限制为仅与 .php 或 .phtml 文件类型相关。

这是否可能让 Sniffs 仅使用或忽略定义的文件类型，或者我是否需要在 sniffs process() 方法中进行此检查？

Answer 1

您可以在规则集中使用正则表达式指定排除模式。通过使用否定前瞻(如果您愿意，也可以在后)，您可以将特定的嗅探或错误消息限制为与模式匹配的文件。

此示例仅对 .phtml 文件运行 DoubleQuoteUsage 嗅探:

<rule ref="Squiz.Strings.DoubleQuoteUsage">
  <exclude-pattern>*\.(?!phtml$)</exclude-pattern>
</rule>

但当前的 PHPCS 版本使用 | 作为正则表达式的分隔符，转义该字符在 PHP 中似乎不起作用。我刚刚在 phpcs-fixer 分支(发布的 2.x 行)中对此进行了更改，允许您这样做:

<rule ref="Squiz.Strings.DoubleQuoteUsage">
  <exclude-pattern>*\.(?!(php$|phtml$))</exclude-pattern>
</rule>

如果您想试一试，可以克隆 git 存储库， checkout phpcs-fixer 分支并直接运行代码。或者您可以通过 composer 要求 2.0.*@dev。

如果没有，您将需要在嗅探的 process() 方法中自行检查文件名。