ShellCheck的功能

众所周知, 终端是Linux系统不可分割的一部分 以及我们在航站楼所做的一切背后, 有一个外壳,一个与操作系统本身交互的程序。 我们在终端中输入的每个命令最终都会由外壳程序解释,然后采取相应的行动。

UNIX shell不仅是命令解释器,而且还用作编程语言。 Shell作为一种编程语言,提供变量,控制流构造,预算和功能。

包含命令和Shell代码的文件称为Shell脚本。 因此,您可以使用Shell脚本为系统执行各种复杂的任务和自动化。

ShellCheck是一个静态分析工具,它显示bash / sh shell脚本中错误代码的警告和建议。

它可以以多种方式使用:通过将外壳脚本粘贴到在线编辑器中以从​​Web上进行​​运行,或者可以将其安装在系统上并从终端运行,然后将其与文本编辑器集成在一起,以及您的汇编或证明套件。

ShellCheck主要执行三件事:

  • 指出并解释典型的初学者语法问题,这些问题会导致shell发出错误的错误消息。
  • 指出并解释导致shell表现异常的典型中间层语义问题。
  • 它还指出了一些细微的警告,这些警告可能会导致本来可以运行的高级脚本在将来的情况下失败

在线使用

顾名思义,它提供了一个在线的检查地址​​https://www.shellcheck.net/​​,进入网址即可使用。
例如,你输入你的脚本内容:

#!/bin/sh
for n in {1..$RANDOM}
do
str=""
if (( n % 3 == 0 ))
then
str="fizz"
fi
if [ $[n%5] == 0 ]
then
str="$strbuzz"
fi
if [[ ! $str ]]
then
str="$n"
fi
echo "$str"
done

它会给出错误提示或者建议:

Line 2:
for n in {1..$RANDOM}
^-- SC2039: In POSIX sh, brace expansion is undefined.
^-- SC2039: In POSIX sh, RANDOM is undefined.

Line 5:
if (( n % 3 == 0 ))
^-- SC2039: In POSIX sh, standalone ((..)) is undefined.

Line 9:
if [ $[n%5] == 0 ]
^-- SC2039: In POSIX sh, $[..] in place of $((..)) is undefined.
^-- SC2007: Use $((..)) instead of deprecated $[..]
^-- SC2039: In POSIX sh, == in place of = is undefined.

Line 11:
str="$strbuzz"
^-- SC2154: strbuzz is referenced but not assigned.

Line 13:
if [[ ! $str ]]
^-- SC2039: In POSIX sh, [[ ]] is undefined.

怎么样,是不是很给力,每个可能的错误都提示了。新手写shell出现莫名的报错时,可以尝试使用奥。当然例子中很多并不是真的错误,而是某种写法不符合POSIX标准,这种情况也应该避免。

命令行使用

debian、ubuntu下:

apt-get install shellcheck

RHEL、CentOS和Scientific Linux(官方:On EPEL based distros:).

yum -y install epel-release
sudo yum install ShellCheck

On Fedora based distros:

dnf install ShellCheck

On FreeBSD:

pkg install hs-ShellCheck

On macOS (OS X) with Homebrew:

brew install shellcheck

Or with MacPorts:

sudo port install shellcheck

On OpenBSD:

pkg_add shellcheck

On openSUSE

zypper in ShellCheck

Or use OneClickInstall - ​​https://software.opensuse.org/package/ShellCheck​

On Solus:

eopkg install shellcheck

On Windows (via ​​chocolatey​​):

C:\> choco install shellcheck

Or Windows (via ​​scoop​​):

C:\> scoop install shellcheck
  • 使用方法:
$ shellcheck myscript.sh

ShellCheck是一个静态分析工具_Shell

编辑器中使用

当然也可以把它安装到你熟悉的编辑器中,虽然它们本身都有语法高亮的功能,但是并没有直接的信息提示,安装shellcheck类工具,达到编写即提示的效果。

  • Emacs, 可以使用 Flycheck.
  • Sublime,可以使用 SublimeLinter.
  • Atom,可以使用 Linter.
  • vim ,可以使用ale或者syntastic

当然了,现代很多IDE都有这样检查功能,这里只说编辑器。

这里以syntastic为例,实际上它支持多种语言的语法检查。
安装过程:

1.安装pathogen.vim

$ mkdir -p ~/.vim/autoload ~/.vim/bundle && \
curl -LSso ~/.vim/autoload/pathogen.vim https://tpo.pe/pathogen.vim

并且在vimrc文件中配置以下内容:

execute pathogen#infect()

2.安装 Install syntastic

cd ~/.vim/bundle && \
git clone --depth=1 https://github.com/vim-syntastic/syntastic.git

3.测试安装情况
打开vim,输入以下内容

:Helptags

如果没有报错,说明安装正常。
在vimrc中配置以下内容:

set statusline+=%#warningmsg#
set statusline+=%{SyntasticStatuslineFlag()}
set statusline+=%*

let g:syntastic_always_populate_loc_list = 1
let g:syntastic_auto_loc_list = 1
let g:syntastic_check_on_open = 1

在goland编辑器中,集成了检测shell script脚本文件,提示安装shellcheck。

ShellCheck是一个静态分析工具_Line_02