Zum Überprüfen von Fehlern in Shell-Scripten hat sich das Kommandozeilen-Tool ShellCheck als Quasi-Standard etabliert. Den Shell-Dialekt (sh, bash, dash, ksh oder busybox), dessen jeweilige Checks angewandt werden sollen, kann ShellCheck anhand der Dateiendung oder dem Shebang des zu prüfenden Scripts erkennen, andernfalls muss dieser mit der Option --shell bestimmt werden.
Die Warnungen von ShellCheck bei Bash-Scripten sind eher konservativ gehalten, so dass eine Behebung der angezeigten Fehler nicht unnötigerweise „Bashismen“ erzeugt. Ein moderner Coding-Style mit doppelten statt einfacher Klammern, wie z. B. im Shell Style Guide von Google gefordert, ließe sich aber mit dem optionalen Check require-double-brackets forcieren. Mit der Option --list-optional können die in der jeweiligen Version von ShellCheck verfügbaren optionalen Checks inklusive Beschreibung und Beispiel mit Behebung aufgeführt werden, beispielsweise für die Version 0.11.0:
$ shellcheck --version
ShellCheck - shell script analysis tool
version: 0.11.0
license: GNU General Public License, version 3
website: https://www.shellcheck.net
$ shellcheck --list-optional
name: add-default-case
desc: Suggest adding a default case in `case` statements
example: case $? in 0) echo 'Success';; esac
fix: case $? in 0) echo 'Success';; *) echo 'Fail' ;; esac
name: avoid-negated-conditions
desc: Suggest removing unnecessary comparison negations
example: [ ! "$var" -eq 1 ]
fix: [ "$var" -ne 1 ]
name: avoid-nullary-conditions
desc: Suggest explicitly using -n in `[ $var ]`
example: [ "$var" ]
fix: [ -n "$var" ]
name: check-extra-masked-returns
desc: Check for additional cases where exit codes are masked
example: rm -r "$(get_chroot_dir)/home"
fix: set -e; dir="$(get_chroot_dir)"; rm -r "$dir/home"
name: check-set-e-suppressed
desc: Notify when set -e is suppressed during function invocation
example: set -e; func() { cp *.txt ~/backup; rm *.txt; }; func && echo ok
fix: set -e; func() { cp *.txt ~/backup; rm *.txt; }; func; echo ok
name: check-unassigned-uppercase
desc: Warn when uppercase variables are unassigned
example: echo $VAR
fix: VAR=hello; echo $VAR
name: deprecate-which
desc: Suggest 'command -v' instead of 'which'
example: which javac
fix: command -v javac
name: quote-safe-variables
desc: Suggest quoting variables without metacharacters
example: var=hello; echo $var
fix: var=hello; echo "$var"
name: require-double-brackets
desc: Require [[ and warn about [ in Bash/Ksh
example: [ -e /etc/issue ]
fix: [[ -e /etc/issue ]]
name: require-variable-braces
desc: Suggest putting braces around all variable references
example: var=hello; echo $var
fix: var=hello; echo ${var}
name: useless-use-of-cat
desc: Check for Useless Use Of Cat (UUOC)
example: cat foo | grep bar
fix: grep bar foo
Optionale Checks können mit der Direktive enable in der User-Konfigurationsdatei ~/.config/shellcheckrc hinzugefügt werden, so dass ShellCheck diese künftig automatisch mit berücksichtigt, so z. B.:
enable=avoid-negated-conditions
enable=avoid-nullary-conditions
enable=deprecate-which
enable=require-double-brackets
enable=useless-use-of-cat