visual-studio-code - 忽略或绕过错误 phpcs

Question

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

Answer 1

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

对于警告

在您的 settings.json 中使用以下配置

"phpcs.showWarnings": false,

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

对于错误

您应该通过DOCS了解完整的详细信息，但要删除与 Doc 块相关的错误以及您可以设置的格式标准

"phpcs.errorSeverity": 6,

虽然它主要用于测试或代码审查，通过为两者设置不同的值来检查总警告和错误，但对于开发我不这样做并将其保持为默认值，5但你可以摆脱上面的那些错误你的形象。

Answer 2

vscode -phpcs指的是 GitHub 项目squizlabs/PHP_CodeSniffer，它将PHP_CodeSniffer集成到 VSCode 中。

它的自述文件提到了设置phpcs.ignorePatterns：

一系列 glob 模式，用于在 linting 文档时跳过匹配的文件和文件夹。

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

那是指PHP CodeSniffer--ignore选项。

这不是您想要的，因为它忽略了给定文件集上的所有错误。

但是您可以使用PHP CodeSniffer 语法来忽略错误：

忽略文件的某些部分

您的代码的某些部分可能无法符合您的编码标准。例如，您可能必须打破标准才能与外部库或 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