php - 如何忽略 PHP_CodeSniffer 中的一些错误或警告

Question

我正在使用 PHP_CodeSniffer 来分析我的 php 代码。问题是我的应用程序的代码非常复杂(大约 10,000 个文件)并且它有点旧(大约 15 年)所以它没有遵循像 PSR 这样的标准。
这就是 CodeSniffer 生成非常大的报告的原因。因为解决所有“问题”需要太多时间，我正在考虑忽略一些事情，例如

Class name must begin with a capital letter

或者

Opening brace of a class must be on the line after the definition

有没有办法告诉 CodeSniffer 在创建报告时忽略此类错误？

Answer 1

要仅针对给定的代码片段禁用/重新启用整个编码标准或特定嗅探 - 使用一些特殊注释

// phpcs:disable Generic.Commenting.Todo.Found
$xmlPackage = new XMLPackage;
$xmlPackage['error_code'] = get_default_error_code_value();
// TODO: Add an error message here.
$xmlPackage->send();
// phpcs:enable

或者

// phpcs:disable PEAR,Squiz.Arrays
$foo = [1,2,3];
bar($foo,true);
// phpcs:enable PEAR.Functions.FunctionCallSignature
bar($foo,false);
// phpcs:enable

注:所有 phpcs:disable和 phpcs:enable注释仅适用于它们所在的文件。文件完成处理后，所有嗅探都会为以后的文件重新启用。

您也可以使用 phpcs:ignore 忽略一行。评论。此注释将忽略注释所在的行和下一行。

// phpcs:ignore
$foo = [1,2,3];
bar($foo, false);

// phpcs:ignore Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed
$foo = [1,2,3];
bar($foo, false);

如果您只想检查文件中的一小部分嗅探，您可以在命令行中指定它们

$ phpcs --standard=PEAR --sniffs=Generic.PHP.LowerCaseConstant,PEAR.WhiteSpace.ScopeIndent /path/to/code

或者您可以运行整个编码标准并排除一小部分嗅探

$ phpcs --standard=PEAR --exclude=Generic.PHP.LowerCaseConstant,PEAR.WhiteSpace.ScopeIndent /path/to/code