Debugging and ShellCheck

Published by Programming Line in Bash Shell Scripting. Last updated .

Debugging shell scripts combines parser checks, execution traces, focused logging, and static analysis. Bash can show expanded commands as they run, while ShellCheck identifies quoting, portability, and data-flow mistakes before production.

This lesson develops Debugging and ShellCheck from its underlying shell behavior through practical, runnable examples. The goal is not merely to memorize punctuation, but to understand what Bash expands, what it executes, and how to keep data boundaries intact.

How Debugging and ShellCheck Works

bash -n parses without executing. set -x prints a trace after expansion, so it must not be used around secrets. The PS4 variable can add line numbers to that trace. ShellCheck reasons about common shell semantics that a syntax parser cannot detect.

Bash processes source in stages: it parses the command, performs the relevant expansions, applies redirections, and finally runs a builtin, function, or external program. Quoting affects the expansion stage, while control structures react to exit statuses. Keeping these stages separate in your mental model makes debugging much faster.

Syntax

bash -n script.sh
shellcheck script.sh
PS4='+${LINENO}: ' bash -x script.sh

Whitespace and quoting are part of the language. Do not copy a compact example and then remove quotes or spaces casually: those characters often determine argument boundaries or separate reserved words. Use bash -n script.sh to check syntax without executing the script.

Worked Examples

Example 1: Core behavior

debug=false
$debug && set -x
value='two words'
printf 'Value: <%s>\n' "$value"

Output:

Value: <two words>

The first example keeps every expansion explicit and quotes values at the point where Bash builds the command’s arguments. Trace it one line at a time: assignments update shell state, expansions produce values, and printf receives a format plus distinct arguments.

Example 2: Practical composition

log() {
  local level=$1
  shift
  printf '[%s] %s\n' "$level" "$*" >&2
}
log INFO 'validation complete' 2>&1

Output:

[INFO] validation complete

The second example composes the feature with another shell capability. Its output is deterministic, so you can paste the script into a temporary file, run it, and compare every line. If your result differs, enable a trace locally and inspect the expanded arguments rather than guessing.

Execution Step by Step

  1. Bash reads enough input to form a complete command or compound command.
  2. Parameter, command, and arithmetic expansions are performed where the syntax requests them.
  3. Quoting determines whether expanded text stays together as one argument.
  4. Redirections are connected before the selected command runs.
  5. The command returns an exit status, which a conditional, loop, or following command may use.

This sequence also explains why printing a variable can look correct even when passing it unquoted is unsafe: the destructive splitting happens while Bash constructs arguments, not while the value is stored.

Common Mistakes

  • Leaving set -x enabled around credentials or tokens.
  • Treating a successful bash -n result as proof that the script is logically correct.

Another common mistake is testing only the happy path. Shell programs interact with files, permissions, processes, and user-controlled strings. Always try an empty value, a value containing spaces, and a failing command. Those tests expose most quoting and error-handling defects early.

Best Practices

  • Run bash -n and ShellCheck in CI.
  • Use small functions that can be tested independently.
  • Log decisions and identifiers, never secrets.

For production automation, start scripts with a clear interpreter line, document inputs and outputs, keep functions small, and run ShellCheck. Strict settings can help, but explicit validation and purposeful error messages remain necessary.

Practice Exercises

  • Recreate the first Debugging and ShellCheck example without copying it, then change one input containing a space.
  • Add one validation failure that prints a useful message to standard error and returns a non-zero status.
  • Wrap the central behavior in a function and call it twice with different arguments.

Summary

  • Debugging and ShellCheck is easiest to use correctly when you track parsing, expansion, execution, and exit status separately.
  • Quoted expansions preserve data boundaries and should be the default.
  • Deterministic examples, syntax checks, and failure-path tests turn shell snippets into reliable automation.