Improve your bash/sh shell script with ShellCheck lint script analysis tool

ShellCheck is a static evaluation device for shell scripts. One can use it to finds bugs in your shell scripts. It’s written in Haskell. You will discover warnings and recommendations for bash/sh shell scripts with this device. Allow us to see set up and use ShellCheck on a Linux or Unix-like system to boost your shell scripts, keep away from errors and productiveness.

Shell scripting is enjoyable. It’s helpful to create good (maybe ugly) issues in shell scripting. Shell scripts are helpful for automating processes that you just repeat on the immediate.

ADVERTISEMENTS

ShellCheck lint script evaluation device

The standard of the shell script could be harmful. Most new customers, sysadmins and builders will use StackOverflow, Google, Q & A web site about Linux/Unix for copy and pasting code. It may result in plenty of unhealthy code and errors. For instance, catastrophic rm command as VAR not outlined in any respect:
rm -rf “$VAR/*”
You’ll be able to repair many such issues whereas writing shell scripts utilizing a linting device resembling shellcheck. Allow us to keep protected and carry out shell script evaluation with ShellCheck device.

Putting in ShellCheck

The best method to set up ShellCheck domestically is thru your bundle managers resembling apt/apt-get/yum and pals as per your Linux distro or Unix variant. Run instructions as per your distro.

Set up ShellCheck on a Debian/Ubuntu Linux

Kind the next apt command/apt-get command:
$ sudo apt set up shellcheck
Pattern outputs:

Set up ShellCheck on a CentOS/RHEL/Fedora/Oracle Linux

First allow EPEL repo on a CentOS/RHEL:
$ sudo yum -y set up epel-release
Subsequent, sort the next yum command:
$ sudo yum set up ShellCheck
Pattern outputs:

If you’re utilizing a Fedora Linux, run the next dnf command:
$ sudo dnf set up ShellCheck

Set up ShellCheck on an Arch Linux

Kind the next pacman command:
$ sudo pacman -S shellcheck

Putting in ShellCheck on a Gentoo Linux

Kind the next emerge command:
$ sudo emerge –ask shellcheck

Set up ShellCheck on an OpenSUSE Linux

Run the next zypper command:
$ sudo zypper in ShellCheck

macOS Unix set up ShellCheck

Strive the next port command if you’re utilizing MacPorts:
$ port set up shellcheck
If you happen to use Homebrew on a macOS/OS X, sort the next brew command:
$ brew set up shellcheck

Alpine Linux set up ShellCheck

Execute the apk command:
# apk add shellcheck

Easy methods to use ShellCheck

Allow us to see my pattern shell script with the cat command:
$ cat -n backupme
Pattern outputs:

Run shellcheck backupme within the terminal:
$ shellcheck backupme
Pattern outputs:

The shellcheck requested me to repair unquoted variables and different points. Right here is my up to date script as per warnings:
$ cat -n backupme
Pattern outputs:

One other session utilizing shellcheck a shell script static evaluation device:

In /house/vivek/bin/faqtoc line 2:
code=””
^—————–^ SC2124: Assigning an array to a string! Assign as array, or use * as a substitute of @ to concatenate.

In /house/vivek/bin/faqtoc line 5:
[ $? -eq 0 ] && xclip -sel clip;
^– SC2181: Test exit code instantly with e.g. ‘if mycmd;’, not not directly with $?.

For extra info:
https://www.shellcheck.web/wiki/SC2124 — Assigning an array to a string! A…
https://www.shellcheck.web/wiki/SC2181 — Test exit code instantly with e.g…

Easy methods to combine shellcheck in your textual content editor

You’ll be able to shellcheck with VIM or emacs textual content editor instantly. I’m utilizing neomake vim plugin. It’s an asynchronous linting and make framework for Neovim/Vim. I put in it utilizing vim-plug plugin supervisor in my ~/.vimrc:
name plug#start(‘~/.vim/plugged’)
Plug ‘pearofducks/ansible-vim’
” set up and use neomake linting
Plug ‘neomake/neomake’
name plug#finish()
To put in ansible-vim and neomake/neomake sort the next command in vim:
:PlugInstall
To make use of plugin sort the next command whereas writing/modifying your bash/sh scripts:
:Neomake
Pattern outputs:

Conclusion

Total it is a wonderful little device for enhancing and fixing your shell scripts. It may detect many widespread errors and errors. For more information see github web page.

ADVERTISEMENTS