mcpField
S
shellcheck-configuration

shellcheck-configuration

github.com/wshobsonTesting & quality41.9k11.7k installsUpdated 2w ago
Repository

About shellcheck-configuration

A ShellCheck configuration and static-analysis skill for people maintaining shell scripts. It covers linting setup, warning interpretation, rule configuration, and integration into development workflows.

Key features

  1. 01Configure ShellCheck for target shells
  2. 02Analyze scripts for common issues
  3. 03Understand warnings and error codes
  4. 04Suppress false positives with rationale
  5. 05Integrate checks into CI/CD and editors

Use cases

  1. 01Add shell linting to CI/CD pipelines
  2. 02Review existing scripts for issues
  3. 03Configure rules for project requirements
  4. 04Enforce script quality before merging

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/wshobson/agents --skill shellcheck-configuration

After installing, type/shellcheck-configurationin Claude Code to confirm it loaded.

Bundled filesreferences/details.md

Details

From the project README

ShellCheck Configuration and Static Analysis

Comprehensive guidance for configuring and using ShellCheck to improve shell script quality, catch common pitfalls, and enforce best practices through static code analysis.

When to Use This Skill

  • Setting up linting for shell scripts in CI/CD pipelines
  • Analyzing existing shell scripts for issues
  • Understanding ShellCheck error codes and warnings
  • Configuring ShellCheck for specific project requirements
  • Integrating ShellCheck into development workflows
  • Suppressing false positives and configuring rule sets
  • Enforcing consistent code quality standards
  • Migrating scripts to meet quality gates

Detailed patterns and worked examples

Detailed pattern documentation lives in references/details.md. Read that file when the navigation tier above is insufficient.

Best Practices

  1. Run ShellCheck in CI/CD - Catch issues before merging
  2. Configure for your target shell - Don't analyze bash as sh
  3. Document exclusions - Explain why violations are suppressed
  4. Address violations - Don't just disable warnings
  5. Enable strict mode - Use --enable=all with careful exclusions
  6. Update regularly - Keep ShellCheck current for new checks
  7. Use pre-commit hooks - Catch issues locally before pushing
  8. Integrate with editors - Get real-time feedback during development

Comments

Markdown supported