shell

シェルスクリプトのベストプラクティス（コミュニティ）

AI エージェントや LLM 向けに作成された、シェルスクリプトの包括的なベストプラクティスガイドです。9 つのカテゴリにわたる 49 のルールが含まれており、重大（安全性、移植性）から段階的（スタイル）まで、影響度に応じて優先順位が付けられています。各ルールには、詳細な説明、誤った実装と正しい実装を比較した実例、具体的な影響指標が含まれています。

適用する場面

次の場合に、これらのガイドラインを参照してください。

• 新しい bash または POSIX シェルスクリプトを作成するとき
• シェルスクリプトのセキュリティ上の脆弱性をレビューするとき
• スクリプトが予期せず失敗したり、想定外の動作をしたりする原因を調査するとき
• Linux、macOS、コンテナ間でスクリプトを移植するとき
• シェルスクリプトのパフォーマンスを最適化するとき
• シェルスクリプトを使った CI/CD パイプラインを設定するとき

優先度別のルールカテゴリ

優先度	カテゴリ	影響度	プレフィックス	ルール数
1	安全性とセキュリティ	重大	safety-	6
2	移植性	重大	port-	5
3	エラー処理	高	err-	8
4	変数とデータ	高	var-	5
5	クォートと展開	中〜高	quote-	6
6	関数と構造	中	func-	5
7	テストと条件分岐	中	test-	5
8	パフォーマンス	低〜中	perf-	6
9	スタイルと書式	低	style-	3

クイックリファレンス

1. 安全性とセキュリティ（重大）

• safety-command-injection - ユーザー入力によるコマンドインジェクションを防ぐ
• safety-eval-avoidance - 動的なコマンドに eval を使用しない
• safety-absolute-paths - 外部コマンドには絶対パスを使用する
• safety-temp-files - 安全な一時ファイルを作成する
• safety-suid-forbidden - シェルスクリプトで SUID/SGID を決して使用しない
• safety-argument-injection - ダブルダッシュを使って引数インジェクションを防ぐ

2. 移植性（重大）

• port-shebang-selection - 移植性の要件に基づいて shebang を選択する
• port-avoid-bashisms - POSIX スクリプトでは bash 固有の構文を避ける
• port-printf-over-echo - 移植性のため、echo の代わりに printf を使用する
• port-export-syntax - 移植可能な export 構文を使用する
• port-test-portability - 移植可能な test 構文を使用する

3. エラー処理（高）

• err-strict-mode - エラーを検出するために厳格モードを使用する
• err-exit-codes - 意味のある終了コードを使用する
• err-trap-cleanup - 終了時のクリーンアップに trap を使用する
• err-stderr-messages - エラーメッセージを stderr に出力する
• err-pipefail - パイプラインのエラーを検出するために pipefail を使用する
• err-check-commands - コマンドの成功を明示的に確認する
• err-shellcheck - 静的解析に ShellCheck を使用する
• err-debug-tracing - set -x と PS4 でデバッグトレースを使用する

4. 変数とデータ（高）

• var-use-arrays - 文字列ではなく配列をリストに使用する
• var-local-scope - 関数内の変数には local を使用する
• var-naming-conventions - 変数の命名規則に従う
• var-readonly-constants - 定数には readonly を使用する
• var-default-values - デフォルト値にはパラメーター展開を使用する

5. 引用と展開（中〜高）

• quote-always-quote-variables - 変数展開は常に引用符で囲みます
• quote-dollar-at - 引数の受け渡しには "$@" を使用します
• quote-command-substitution - コマンド置換を引用符で囲みます
• quote-brace-expansion - 変数を明確にするために波括弧を使用します
• quote-here-documents - 複数行文字列にはヒアドキュメントを使用します
• quote-glob-safety - グロブ展開を明示的に制御します

6. 関数と構造（中）

• func-main-pattern - main() 関数のパターンを使用します
• func-single-purpose - 単一の目的を持つ関数を記述します
• func-return-values - 戻り値を正しく使用します
• func-documentation - ヘッダーコメントで関数を説明します
• func-avoid-aliases - エイリアスより関数を優先します

7. テストと条件分岐（中）

• test-double-brackets - bash のテストには [[ ]] を使用します
• test-arithmetic - 算術比較には (( )) を使用します
• test-explicit-empty - 空文字列と空でない文字列を明示的にテストします
• test-file-operators - 適切なファイルテスト演算子を使用します
• test-case-patterns - パターンマッチングには case を使用します

8. パフォーマンス（低〜中）

• perf-builtins-over-external - 外部コマンドより組み込みコマンドを使用します
• perf-avoid-subshells - 不要なサブシェルを避けます
• perf-process-substitution - 一時ファイルにはプロセス置換を使用します
• perf-read-files - ファイルを効率的に読み込みます
• perf-parameter-expansion - 文字列操作にはパラメーター展開を使用します
• perf-batch-operations - ループの代わりに操作をまとめて実行します

9. スタイルと書式（低）

• style-indentation - 一貫したインデントを使用します
• style-file-structure - 一貫したファイル構造に従います
• style-comments - 役立つコメントを記述します

使い方

詳しい説明とコード例については、各リファレンスファイルをお読みください。

• セクションの定義 - カテゴリー構成と影響度
• ルールのテンプレート - 新しいルールを追加するためのテンプレート

リファレンスファイル

ファイル	説明
AGENTS.md	すべてのルールをまとめた完全なガイド
references/_sections.md	カテゴリーの定義と順序
assets/templates/_template.md	新しいルール用のテンプレート
metadata.json	バージョンとリファレンス情報

主な情報源

• Google Shell Style Guide
• ShellCheck
• Greg's Wiki (wooledge.org)
• POSIX Shell Specification