有了這個(gè)神器，再也不怕shell寫(xiě)得不對(duì)了
寫(xiě)過(guò)shell腳本的人都知道，即便出現(xiàn)一些簡(jiǎn)單的語(yǔ)法錯(cuò)誤，運(yùn)行的時(shí)候也可能沒(méi)有辦法發(fā)現(xiàn)。有些看似運(yùn)行正確的腳本，實(shí)際上可能在某些分支，某些場(chǎng)景下仍然出現(xiàn)錯(cuò)誤，而有的寫(xiě)法可能運(yùn)行正常，但是卻不符合POSIX標(biāo)準(zhǔn)，不具備可移植性。
誠(chéng)然，shell腳本是解釋運(yùn)行，沒(méi)有辦法向C/C++那樣嚴(yán)格檢查，但是我們?nèi)匀豢梢越柚恍┕ぞ邘椭覀兲崆鞍l(fā)現(xiàn)一些錯(cuò)誤。
shellcheck
shellcheck就是這樣的一個(gè)工具。它可以在多種場(chǎng)景下使用，包括在線，命令行檢查，編輯器配置，下面逐一介紹。
在線使用
顧名思義，它提供了一個(gè)在線的檢查地址，https://www.shellcheck.net/，進(jìn)入網(wǎng)址即可使用。
例如，你輸入你的腳本內(nèi)容：
- #!/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
shell
它會(huì)給出錯(cuò)誤提示或者建議：
- 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.
怎么樣，是不是很給力，每個(gè)可能的錯(cuò)誤都提示了。新手寫(xiě)shell出現(xiàn)莫名的報(bào)錯(cuò)時(shí)，可以嘗試使用奧。當(dāng)然例子中很多并不是真的錯(cuò)誤，而是某種寫(xiě)法不符合POSIX標(biāo)準(zhǔn)，這種情況也應(yīng)該避免。
命令行使用
命令行安裝也很簡(jiǎn)單(記得使用root權(quán)限)，ubuntu下：
- $ apt-get install shellcheck
centos下：
- $ yum -y install epel-release
Fedora下：
- $ dnf install ShellCheck
使用方法也很簡(jiǎn)單了：
- $ shellcheck myscript.sh
舉個(gè)例子，下面的寫(xiě)法是新手最容易出錯(cuò)的地方之一：
- //來(lái)源：公眾號(hào)【編程珠璣】
- //作者：守望先生
- #!/bin/bash
- if[ $# -eq 0 ]
- then
- echo "no para"
- else
- echo "$# para"
- fi
- exit 0
看運(yùn)行報(bào)錯(cuò)：
- ./test.sh: line 4: if[ 0 -eq 0 ]: command not found
- ./test.sh: line 5: syntax error near unexpected token `then'
- ./test.sh: line 5: `then'
只是告訴你在then附近有語(yǔ)法問(wèn)題，到底什么問(wèn)題呢？我們用shellcheck看看：
- $ shellcheck test.sh
- In test.sh line 4:
- if[ $# -eq 0 ]
- ^-- SC1069: You need a space before the [.
這么一看，就很清楚了，原來(lái)[前面少了空格。
編輯器中使用
當(dāng)然也可以把它安裝到你熟悉的編輯器中，雖然它們本身都有語(yǔ)法高亮的功能，但是并沒(méi)有直接的信息提示，安裝shellcheck類工具，達(dá)到編寫(xiě)即提示的效果。
- Emacs, 可以使用 Flycheck.
- Sublime,可以使用 SublimeLinter.
- Atom，可以使用 Linter.
- vim ,可以使用ale或者syntastic
當(dāng)然了，現(xiàn)代很多IDE都有這樣檢查功能，這里只說(shuō)編輯器。
這里以syntastic為例，實(shí)際上它支持多種語(yǔ)言的語(yǔ)法檢查。
安裝過(guò)程：
1.安裝pathogen.vim
- $ mkdir -p ~/.vim/autoload ~/.vim/bundle && \
- curl -LSso ~/.vim/autoload/pathogen.vim https://tpo.pe/pathogen.vim
并且在vimrc文件中配置以下內(nèi)容：
- execute pathogen#infect()
2.安裝 Install syntastic
- cd ~/.vim/bundle && \
- git clone --depth=1 https://github.com/vim-syntastic/syntastic.git
3.測(cè)試安裝情況
打開(kāi)vim，輸入以下內(nèi)容
- :Helptags
如果沒(méi)有報(bào)錯(cuò)，說(shuō)明安裝正常。
在vimrc中配置以下內(nèi)容：
- 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
常用：
- :Errors 顯示錯(cuò)誤面板
- :lnext 到下一個(gè)錯(cuò)誤
- :lprevious 到上一個(gè)錯(cuò)誤
更多安裝詳情也可以參考https://github.com/vim-syntastic/syntastic。
以上是官網(wǎng)推薦的安裝方式，也可以在安裝了Vundle（這是一種老舊的插件管理方式，你可以嘗試vim-plug等其他插件管理工具）的前提下，通過(guò)在配置文件中加入：
- Plugin 'scrooloose/syntastic'
打開(kāi)vim輸入：
- ：PluginInstall
即可安裝。
使用效果：
shell檢查：
C語(yǔ)言語(yǔ)法檢查：
實(shí)際上它可以支持幾乎所有常見(jiàn)編程語(yǔ)言的語(yǔ)法檢查。
不知道vimrc文件在哪里？
打開(kāi)vim，輸入：
- ：version
就可以看到啦：
- system vimrc file: "$VIM/vimrc"
- user vimrc file: "$HOME/.vimrc"
- 2nd user vimrc file: "~/.vim/vimrc"
- user exrc file: "$HOME/.exrc"
- system gvimrc file: "$VIM/gvimrc"
- user gvimrc file: "$HOME/.gvimrc"
- 2nd user gvimrc file: "~/.vim/gvimrc"
- system menu file: "$VIMRUNTIME/menu.vim"
它們區(qū)別在于生效范圍不一樣，對(duì)于用戶的vimrc，自然只是對(duì)特定用戶生效。
總結(jié)
工欲善其事必先利其器，有好的工具，自然就該用起來(lái)。歡迎分享更多的方法或工具。
