如何抑制不相关的 ShellCheck 消息？

Question

环境

系统：Linux Mint 19（基于Ubuntu 18.04）。

编辑器：我使用带有 ShellCheck 插件的Visual Studio Code （官方网站）来即时检查错误、警告和提示。

---

壳牌检查

是每个 shell 脚本编写者的必备工具。

尽管开发人员必须付出巨大的努力使其尽可能好，但它有时会产生不相关的警告和/或信息。

示例代码，带有此类消息（警告SC2120 + 直接相邻信息SC2119 ）：

---

POSIX shell 脚本片段

am_i_root()
# expected arguments: none
{
    # check if no argument has been passed
    [ "${#}" -eq 0 ] || print_error_and_exit 1 "am_i_root" "Some arguments have been passed to the function!\\n\\tNo arguments expected.\\n\\tPassed: ${*}"

    # check if the user is root
    # this will return an exit code of the command itself directly
    [ "$(id -u)" -eq 0 ]
}

# check if the user had by any chance run the script with root privileges and if so, quit
am_i_root && print_error_and_exit 1 "am_i_root" "This script should not be run as root!\\n\\tQuiting to safety."

---

在哪里：

• am_i_root正在检查传递的不需要的参数。 它的真正目的是不言自明的。

• print_error_and_exit就像它的名字所说的那样，它或多或少是不言自明的。

• 如果已传递任何参数，我希望函数/脚本打印错误消息并退出。

---

题

如何禁用这些消息（仅限本地）？

Answer 1

做这件事之前请三思！

仅当您 100.0% 肯定消息确实不相关时才这样做。 然后，在此处和此处阅读有关此主题的 Wiki。

---

一旦你向自己保证消息是无关紧要的

虽然一般来说，有更多的方法可以实现这个目标，我说在本地禁用这些消息，所以实际上只有一种。

在实际消息发生之前添加以下行：

    # shellcheck disable=code

值得注意的是，在同一行之后添加文本将导致错误，因为它也会被 shellcheck 解释。 如果您想解释为什么要取消警告，您可以添加另一个哈希 # 以防止 shellcheck 干扰该行的其余部分

不正确：

# shellcheck disable=code irrelevant because reasons

正确的：

# shellcheck disable=code # code is irrelevant because reasons

Answer 2

使用 Shellcheck 0.7.1 及更高版本，您可以通过过滤严重性来抑制命令行上不相关的消息（有效选项为：错误、警告、信息、样式）：

$ shellcheck --severity=error my_script.sh

这只会显示错误，并会抑制烦人的SC2034 、 SC2086等警告和样式建议。

您还可以使用 .shellcheckrc 文件中的指令抑制每个代码的消息，例如：

disable=SC2076,SC2016

这两个选项都允许您全局过滤消息，而不必使用相同的指令编辑每个源代码文件。

如果您的发行版没有最新版本，您可以使用以下内容进行升级：

scversion="stable" # or "0.7.1" or "latest"
wget -qO- "https://github.com/koalaman/shellcheck/releases/download/${scversion?}/shellcheck-${scversion?}.linux.x86_64.tar.xz" | tar -xJv
sudo cp "shellcheck-${scversion}/shellcheck" /usr/bin/
shellcheck --version