What is the benefit of using a .shellcheckrc file?

A .shellcheckrc file allows you to define project-wide rules, ensuring that all developers and automated systems use the same linting standards for consistency.

How do I integrate ShellCheck into my GitHub Actions?

You can utilize the official 'koalaman/shellcheck-alpine' Docker image or community-maintained actions to run shellcheck automatically on every push or pull request.

How do I ignore a specific ShellCheck warning?

You can use the comment syntax '# shellcheck disable=SCXXXX' on the line immediately preceding the code or at the top of the file to suppress specific rules.

Does ShellCheck support scripts other than Bash?

Absolutely. ShellCheck supports sh, dash, ksh, and other POSIX-compliant shells through explicit configuration or shebang detection.

Can I use this skill to make scripts POSIX compliant?

Yes, by configuring ShellCheck with the '--shell=sh' flag or using the skill's POSIX compliance templates, you can identify and fix non-portable shell extensions.

ShellCheck Configuration & Static Analysis

Name: ShellCheck Configuration & Static Analysis
Author: HermeticOrmus

byHermeticOrmus

•

Developer Tools

Optimizes shell script quality and portability by mastering ShellCheck static analysis, rule configurations, and CI/CD integration.

This skill provides comprehensive guidance for implementing ShellCheck to detect bugs, syntax errors, and non-portable patterns in shell scripts. It covers everything from local environment setup and .shellcheckrc configuration to advanced CI/CD pipeline integration and the resolution of common SC-prefixed error codes. Ideal for developers looking to enforce consistent coding standards, prevent shell-specific pitfalls, and automate quality gates in their development workflow.

Key Features

014 GitHub stars

02Integration patterns for Git pre-commit hooks and GitHub Actions workflows

03Detailed configuration of .shellcheckrc for project-wide linting standards

04Advanced techniques for suppressing false positives and rule exclusions

05Automated static analysis for Bash, sh, dash, and ksh dialects

06Comprehensive library of common SC error codes with optimized fixes

Use Cases

01Enforcing standardized shell scripting best practices across large engineering teams

02Automating shell script linting within CI/CD pipelines to ensure production-grade code

03Debugging complex POSIX compliance issues when migrating scripts across different Linux environments

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add hermeticormus/claude-code-game-development shellcheck-configuration

For use in Claude.ai and ChatGPT

Download Skill