忽略或绕过phpcs错误

时间:2018-07-13 21:50:07

标签: visual-studio-code phpcs

如何绕过或忽略vscode中的特定错误/警告?,我正在使用phpcs。

enter image description here

2 个答案:

答案 0 :(得分:1)

您要查找的是忽略由vscode控制台中的phpcs通知的警告和/或错误。

警告

在settings.json中使用以下配置

"phpcs.showWarnings": false,

这将删除输出控制台中显示的所有警告。

对于错误

您应该经过DOCS以获得完整的详细信息,但是要消除与Doc块和格式标准有关的错误,可以设置

"phpcs.errorSeverity": 6,

尽管它主要用于测试或代码审查,以通过为两者设置不同的值来检查总警告和错误,但是对于开发,我不这样做,并将其保留为默认值5,但是您可以消除图片上方的这些错误。

答案 1 :(得分:0)

vscode-phpcs是指GitHub项目squizlabs/PHP_CodeSniffer,该项目将PHP_CodeSniffer集成到VSCode中。

readme mentions设置phpcs.ignorePatterns

  

一组glob模式,可在整理文档时跳过匹配的文件和文件夹。

{
    "phpcs.ignorePatterns": [
        "*/ignored-file.php",
        "*/ignored-dir/*"
    ]
}

是指PHP CodeSniffer --ignore option

这不是您真正想要的,因为它会忽略给定文件集上的所有所有错误。

但是您可以使用PHP CodeSniffer syntax to ignore errors

忽略文件的一部分

  

您的代码的某些部分可能不符合您的编码标准。例如,您可能必须打破标准才能与外部库或Web服务集成。
  要停止PHP_CodeSniffer对此代码生成错误,可以将其包装在特殊注释中。然后,PHP_CodeSniffer将隐藏为这些代码行生成的所有错误和警告。

$xmlPackage = new XMLPackage;
// phpcs:disable
$xmlPackage['error_code'] = get_default_error_code_value();
$xmlPackage->send();
// phpcs:enable

同样,也不完全是您想要的,因为您必须逐个文件指定

  

您可以使用逗号分隔的列表来禁用多个错误消息代码,嗅探,类别或标准。
  您也可以选择性地重新启用所需的功能。

     

以下示例在有选择地重新启用特定嗅探之前,禁用了整个PEAR编码标准以及所有Squiz数组嗅探。然后,它最后重新启用所有检查规则。

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