ShellCheck

• Overview
• Installation
  • Dockerized
• Disable
• VScode

Overview

ShellCheck is a static analysis tool for shell scripts.

Installation

ShellCheck is available through most package managers. @see https://github.com/koalaman/shellcheck?tab=readme-ov-file#installing

brew search shellcheck

Dockerized

To run without installing:

docker run --rm -v "$PWD:/mnt" koalaman/shellcheck:stable <FILES>

Disable

• Specify a code (SC9999), code range (SC9000-SC9999), all to disable.

hexToAscii() {
  # shellcheck disable=SC2059
  printf "\x$1"
}

VScode

• Homepage: timonwong.shellcheck

Requires locally-installed ShellCheck

  "shellcheck.enable": true,
  "shellcheck.enableQuickFix": true,
  "shellcheck.run": "onType",
  "shellcheck.executablePath": "/home/linuxbrew/.linuxbrew/bin/shellcheck",