Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Shellcheck Processor

Purpose

Lints shell scripts using shellcheck.

How It Works

Discovers .sh and .bash files in the project (excluding common build tool directories), runs shellcheck on each file, and records success in the cache. A non-zero exit code from shellcheck fails the product.

This processor supports batch mode, allowing multiple files to be checked in a single shellcheck invocation for better performance.

Source Files

  • Input: **/*.sh, **/*.bash
  • Output: none (linter)

Configuration

[processor.shellcheck]
linter = "shellcheck"                       # The shellcheck command to run
args = []                                    # Additional arguments to pass to shellcheck
extra_inputs = []                            # Additional files that trigger rebuilds when changed
KeyTypeDefaultDescription
linterstring"shellcheck"The shellcheck executable to run
argsstring[][]Extra arguments passed to shellcheck
extra_inputsstring[][]Extra files whose changes trigger rebuilds