shell-script-validation

---
name: shell-script-validation
description: >-
  Validate shell scripts with bash -n and shellcheck for syntax safety and maintainability checks.
  Does not enforce Bats suite pairing (TEST-00) — companion stem `bats` covers pairing rules.
  Use when committing script changes, running CI validation, or debugging shellcheck findings in PRs.
license: Apache-2.0
metadata:
  author: y-miyazaki
  version: "1.2.1"
---

## Input

- Shell script path or directory (optional): defaults to workspace root
- Validation script (required): `scripts/validate.sh`
- Canonical flags (required): `-v -f -d` unless opted out below
- `--check-function-docs` (optional): omit only when targets intentionally skip Google function header sections

## Output Specification

Return structured Markdown in accordance with [references/common-output-format.md](references/common-output-format.md). That file is the source of truth for the output contract.

Structured results for bash -n and shellcheck (syntax and lint only). With `--check-function-docs`, also reports [Google Shell Style Guide](https://google.github.io/styleguide/shellguide.html#s4.2-function-comments) function header sections.

## Execution Scope

- **Always use `scripts/validate.sh`** for comprehensive validation. Do not run individual commands.
- Script runs checks in fixed order.
- Individual commands are for debugging only (see [references/common-individual-commands.md](references/common-individual-commands.md)).
- **Bats output:** By default only failing tests and the summary line are printed. Use `-v` for the full pass/fail listing.

### USE FOR:

- run shell script syntax and lint validation before merge
- reproduce CI failures for shell scripts
- validate a specific script path during iterative fixes
- normalize function doc section order when this skill ships `scripts/fix_function_doc_order.sh`

### DO NOT USE FOR:

- perform architecture/design review of shell scripts
- modify business logic in scripts as a primary task
- validate non-shell files
- enforce Bats suite pairing or suite layout (companion stem `bats` covers pairing rules)

## Reference Files Guide

- [common-checklist.md](references/common-checklist.md) (always read)
- [common-output-format.md](references/common-output-format.md) (always read)
- [common-troubleshooting.md](references/common-troubleshooting.md) (read on failure)
- [common-individual-commands.md](references/common-individual-commands.md) (read on failure)
- [category-standards.md](references/category-standards.md) (read on failure)

## Workflow

1. Run `bash scripts/validate.sh -v -f -d` with an optional target path (file or directory under review).
2. When function doc sections are out of order and `scripts/fix_function_doc_order.sh` exists, run it on the target before re-validating.
3. Review auto-fix diffs from `-f` before continuing.
4. If checks fail, fix reported issues and rerun the same command.
5. Retry at most 2 times after fixes; if checks still fail, return blocking findings and stop.

### Error Handling

| Condition                             | Severity    | Action                                                                                                |
| ------------------------------------- | ----------- | ----------------------------------------------------------------------------------------------------- |
| `scripts/validate.sh` missing         | Fatal       | Stop; report missing script                                                                           |
| No shell scripts under target path    | Info        | Report no reviewable scripts; stop                                                                    |
| bash -n or shellcheck missing         | Recoverable | Defer checks for that tool; note in deferred table                                                    |
| Single tool fails, other succeeds     | Recoverable | Report passing tool; defer failed tool with exit status                                               |
| All tools fail                        | Fatal       | Return `status: failed` with per-tool stderr summaries                                                |
| Function docs intentionally skipped   | Info        | Omit `--check-function-docs`; document opt-out in Summary                                             |
| `common-checklist.md` unavailable     | Fatal       | Stop; report missing dependency                                                                       |
| `common-output-format.md` unavailable | Recoverable | Note missing file; emit `## Checks Summary`, `## Checks (Failed/Deferred Only)`, and `## Issues` only |

### Examples

- Prompt: `Validate shell scripts (syntax, shellcheck, optional function docs)`
- Command: `bash scripts/validate.sh -v -f -d`
- Result: Structured report per [references/common-output-format.md](references/common-output-format.md). Additional invocations: [common-individual-commands.md](references/common-individual-commands.md) (read on debugging).

• SKILL.md 5 KB
• eval.yaml 1 KB
• evals/tasks/shell-script-validation-basic.yaml 1 KB
• evals/tasks/shell-script-validation-boundary-guardrail.yaml 1 KB
• evals/tasks/shell-script-validation-canonical-flags.yaml 1 KB
• evals/tasks/shell-script-validation-opt-out-function-docs.yaml 1 KB
• evals/tasks/shell-script-validation-partial-failure.yaml 1 KB
• evals/tasks/shell-script-validation-structured-output.yaml 1 KB
• evals/tasks/shell-script-validation-target-path.yaml 1 KB
• evals/tasks/shell-script-validation-trigger-negative.yaml 1 KB
• evals/tasks/shell-script-validation-trigger-positive.yaml 1 KB
• references/category-standards.md 3 KB
• references/common-checklist.md 2 KB
• references/common-individual-commands.md 1 KB
• references/common-output-format.md 1 KB
• references/common-troubleshooting.md 1 KB
• scripts/fix_function_doc_order.sh 15 KB
• scripts/validate.sh 56 KB
• scripts/lib/all.sh 1 KB
• scripts/lib/aws.sh 29 KB
• scripts/lib/common.sh 9 KB
• scripts/lib/csv.sh 4 KB
• scripts/lib/json.sh 8 KB
• scripts/lib/repo_paths.sh 15 KB
• scripts/lib/terraform.sh 13 KB
• scripts/lib/validation.sh 14 KB
• scripts/lib/yaml_map_order.py 6 KB