@codacy/tools-shellcheck-0

Table of Contents

• Overview
• Updating patterns
• Updating the ShellCheck version
• Development
• Notes for maintainers

Overview

Shell script linter using the ShellCheck binary. Uses the CLI execution strategy — spawns shellcheck via spawnTool() and parses its JSON output.

| Property | Value | |----------|-------| | Tool ID | shellcheck | | Codacy UUID | 233f8aac-4fb6-4193-8a17-e64515bea152 | | Strategy | CLI | | Languages | Shell (Bash, sh, dash, ksh) | | Binary | shellcheck | | File patterns | **/*.sh, **/*.bash |

Updating patterns

# Re-fetch pattern metadata from the Codacy API
pnpm prefetch

# Commit the result
git add src/patterns.json

Pattern IDs follow the format shellcheck_SC2086, shellcheck_SC2034, etc.

Updating the ShellCheck version

1. Update preferredVersion in src/adapter.ts
2. Update the download URL template if the release format changed
3. Run pnpm prefetch to check for new/removed rules
4. Run pnpm test to verify compatibility
5. If the major version changes, create a new adapter package (shellcheck-1/)

Development

pnpm build    # Build with tsup
pnpm test     # Run tests (requires shellcheck in PATH or auto-install)

Notes for maintainers

• ShellCheck outputs JSON via --format=json1.
• Exit code 0 = no findings, 1 = findings found (normal), 2+ = error.
• The binary is downloaded from GitHub releases and installed to ~/.codacy/tools/shellcheck-0/.