Agent RulesAgent Rules
SH

ShellCheck

ShellCheck static analysis for Shell/Bash scripts

Shell/Bash
Linter / Formatter
Default
Use in BuilderAll Shell/Bash Options

Details

Language / Topic
shellShell/Bash
Category
Linter / Formatter

Rules

balanced
- Run `shellcheck script.sh` on every script before committing — it catches quoting errors, undefined variables, and portability issues.
- Add `# shellcheck disable=SC2034` inline to suppress false-positive warnings on intentionally unused variables, not globally.
- Use `shfmt -i 2 -ci` to auto-format scripts with 2-space indentation and case-indent alignment for consistent style.
- Integrate ShellCheck into CI: `shellcheck **/*.sh` via `find . -name '*.sh' | xargs shellcheck` to lint all scripts automatically.
- Use `# shellcheck source=./lib/utils.sh` directives to help ShellCheck resolve sourced file paths for cross-file analysis.
- Configure `shfmt` via `.editorconfig` or a `shfmt` config file to enforce consistent brace styles across the project.
- Prefer `shellcheck -S error` in CI to treat only error-level findings as failures — use `-S warning` locally for stricter feedback.