shellcheck-configuration

概要

shellcheck-configuration とは？

shellcheck-configuration は、シェルスクリプト向けの静的解析ツール ShellCheck の設定と活用を支援するスキルです。リンティング環境の構築、コード問題の修正、スクリプトの環境間移植性の確保に役立つ実践的なガイドを提供します。ベストプラクティスの適用や一般的なシェルスクリプトのエラー検出、CI/CD パイプラインへの品質チェック統合を目指す方に最適です。

どんな人におすすめ？

• Bash、sh、dash、ksh スクリプトを書く開発者
• 自動化スクリプトを管理する DevOps エンジニア
• シェルスクリプトのコード品質基準を徹底したいチーム
• CI/CD ワークフローにシェルスクリプトのリンティングを組み込みたい方

解決できる課題

• 一般的なシェルスクリプトのエラーや落とし穴を検出
• 一貫したコーディング規約の適用を支援
• 品質ゲートを満たすためのスクリプト移行をサポート
• プロジェクト固有の設定や誤検知の抑制に対応

使い方

インストール手順

1. 以下のコマンドでスキルを追加します：
   npx skills add https://github.com/wshobson/agents --skill shellcheck-configuration
2. SKILL.md ファイルを参照し、設定や使用方法の詳細を確認してください。
3. README.md、AGENTS.md、metadata.json などの補助ファイルもあわせてご覧ください。

ShellCheck のセットアップ

• お使いの環境に合わせてパッケージマネージャーから ShellCheck をインストールします：
  • macOS: brew install shellcheck
  • Ubuntu/Debian: apt-get install shellcheck
  • ソースから: 公式リポジトリをクローンし、make build && make install でビルド・インストール
• shellcheck --version でインストールを確認

ShellCheck の設定

• プロジェクトに .shellcheckrc ファイルを作成し、ルールや対象シェルをカスタマイズ
• CI/CD パイプラインに ShellCheck を組み込み、自動リンティングを実現
• ShellCheck のフラグを活用し、プロジェクト要件に合わせた解析を実施

ワークフローの適応

• 提供されているスキルファイルをベースに、リポジトリやツール環境に合わせて設定を調整
• 設定をそのままコピーせず、チームのニーズや運用条件に合わせてカスタマイズしてください

よくある質問

設定例はどこで見られますか？

SKILL.md と .shellcheckrc ファイルにサンプル設定や推奨方法が記載されています。

shellcheck-configuration は CI/CD で使えますか？

はい、このスキルは CI/CD パイプラインへの組み込みを想定しており、自動的なシェルスクリプトのリンティングと品質チェックを可能にします。

対応しているシェルは？

ShellCheck は Bash、sh、dash、ksh などの POSIX 準拠シェルをサポートしています。

誤検知の抑制はどうすればいいですか？

.shellcheckrc ファイルやスクリプト内のインライン設定でルールセットを調整し、特定の警告を抑制できます。

どこから始めればいいですか？

まず SKILL.md ファイルで全体の概要を把握し、その後補助ファイルを参照して詳細を深めてください。Files タブでファイルツリー全体や参照、ヘルパースクリプトも確認できます。