Shellcheck 是一个很好的 Linux Shell 脚本分析工具,可用于检测常见的编程错误。Shellcheck 分析脚本,并通知错误和警告,就像编译器会做的那样。

什么是shellcheck

如果您从事 Linux Bash 开发人员已有一段时间,您可能会在自己的脚本或其他人的脚本中发现大量错误。当我们开发代码时,必然会在代码中引入错误。即使是最优秀的开发人员也可能偶尔会忽略代码中不可预见的复杂性或警告。

在 Bash 中,没有像C++那样的真正的编译器。然而,有一组工具可以在开发 Bash 脚本时提供很大帮助。比如 shellcheck。这个优秀的实用程序将解析 Bash 脚本文件并根据分析过程中发现的内容提出建议。这有点像拥有了一个 Bash 编译器。

像 shellcheck 这样的工具在操作上与其他运行时工具不同,例如执行脚本bash -x以查看正在执行的脚本中的每个命令,并且是实时的。原因是 shellcheck 将分析脚本(文件)而不实际执行它,这与编译器所做的再次相似。

安装shellcheck

要在基于 Debian/Apt 的 Linux 发行版(如 Ubuntu 和 Mint)上安装shellcheck,请在终端中执行以下命令:

linuxmi@linuxmi:~/www.linuxmi.com$ sudo apt install shellcheck

要在基于 RedHat/Yum 的 Linux 发行版(如 RHEL、Centos 和 Fedora)上安装shellcheck,请在终端中执行以下命令:

linuxmi@linuxmi:~/www.linuxmi.com$ sudo yum install shellcheck

运行shellcheck

在安装了 shellcheck 后,我们就可以用一个损坏的脚本做一个简单的测试。首先我们定义我们的脚本linuxmi.com.sh如下:

#!/bin/hash
echo 'Bash 不是 Hash
echo 为我回应更多错误www.linuxmi.com"
if [ -d ./linuxmi }; than
  echo 'sure! < start
fif

你能找到多少bug?(提示:有 8 个!)。

接下来让我们看看 shellcheck 对这段代码的影响:

linuxmi@linuxmi:~/www.linuxmi.com$ shellcheck linuxmi.sh

1、它立即在第一行发现shebang规范存在问题。我们的 shebang 这一行#!/bin/hash应该是#!/bin/bash。让我们解决这个问题。问题 1/8 已修复!

我们还将同时修复 shellcheck 立即识别的另外两个问题:

2、您是否忘记关闭这个单引号字符串?(Did you forget to close this single quoted string?),对于第二行:很准!问题 2/8 已修复。

3、对于第三个问题,我们/开发人员对 shellcheck 的意图有点混乱,这是可以预料的,因为第2 行打开了一个字符串,该字符串'仅在第 5 行看到另一个'时才终止!

由于第三个问题是第二个问题的结果,因此这次运行将允许我们暂时修复两个问题。我们的脚本现在看起来像这样:

#!/bin/bash
echo 'Bash 不是 Hash'
echo 为我回应更多错误www.linuxmi.com"
if [ -d ./linuxmi }; than
  echo 'sure! < start
fif

在进行更正后,让我们再次运行 shellcheck,看看输出是什么。

在这种情况下,shellcheck 看到一个 "在第 3 行打开(即使它在行尾,它实际上是一个打开的双引号),并且即使在脚本结尾(注意第 8 行的指示,这在我们的6行脚本中并不存在,在最后一行之后只有一个空行。让我们清理这一空行,并修复第3行开头的双引号问题,现在可以很容易地理解。问题3/8已修复!

我们的脚本现在看起来像这样:

#!/bin/bash
echo 'Bash 不是 Hash'
echo "为我回应更多错误www.linuxmi.com"
if [ -d ./linuxmi }; than
  echo 'sure! < start
fif

重新运行 shellcheck(注意这些步骤与在其他编码语言中使用编译器有多么相似):

再清楚不过了;提到的语法错误出现在这个 if 表达式中,并且预期测试将在这里结束。我们将按照建议进行操作并将 }更改为],使该行变为if [ -d ./linuxmi ]; than. 问题 4/8 已修复!

我们重新运行 shellcheck,现在显示以下内容:

另一个单引号问题。我们已经知道如何解决这些问题。让我们更改echo 'sure! < startecho 'sure!' < start(问题 5/8 已修复!)

并再次重新运行 shellcheck:

#!/bin/bash
echo 'Bash 不是 Hash'
echo "为我回应更多错误www.linuxmi.com"
if [ -d ./linuxmi ]; then
  echo 'sure!' < start
fif

另一个 shellcheck 运行为我们提供了另一个有用的信息:

我们把fi弄丢了!哦哦,是的,fif不行。我们要在脚本的最后一行更改fiffi

(问题 7/8)修复。

并再次运行 shellcheck!

重定向问题。老实说,我没想到shellcheck也会发现这个错误,因为<它也可以在 Bash 中使用,但它确实发现了。事实上,我们的重定向是为了>代替<.

问题 8/8 – 所有问题 – 已修复!这就引出了最后一个脚本

#!/bin/bash
echo 'Bash 不是 Hash'
echo "为我回应更多错误www.linuxmi.com"
if [ -d ./linuxmi ]; then
  echo 'sure!' > start
fi

让我们看看 shellcheck 现在是怎么想的。

完美的!从第一次执行开始,脚本运行完美。

如果您查看各种 shellcheck 命令的输出,您还会注意到 shellcheck 的另一个非常方便的功能。

尤其是对于初学者:显示一组超链接(网站链接),可以在终端窗口中单击鼠标,或者您可以选择(如有必要)> 右键单击​​以复制然后粘贴到浏览器中。单击此类链接将带您进入shellcheck GitHub 项目

想要快速检查

如果您只想快速检查最重要的选项,您可能希望查看该--severity={SEVERITY}选项,您可以将{SEVERITY}其中的一个替换为error, warning, info, style.

因此,您只是在寻找错误和警告,您将使用--severity=warning(包括更高级别,在这种情况下仅为error)作为shellcheck的选项。

总结

如果脚本中的逻辑没有问题,则shellcheck在执行脚本之前运行并修复所有发现的问题将确保第一次运行时准完美。您甚至可以在该编码挑战中使用 shellcheck 进行下一次现场 Bash 编码面试!在本文中,我们探讨了脚本中可能出现的各种问题以及如何shellcheck处理它们。

享受无错误的脚本!

发表评论