効率化のための再利用可能なBashスクリプトテンプレートの作成

再利用可能なBashスクリプトテンプレートは、タスクを自動化するたびに同じ安全チェックを書き直す手間を省きます。優れたテンプレートは、プロジェクト固有のロジックを追加する前に、厳格なエラーハンドリング、予測可能なログ出力、使用方法のヘルプ、引数解析、クリーンアップフックをスクリプトに提供します。

目標は大規模なフレームワークではなく、日常的なスクリプトを一貫性のあるデバッグしやすいものにする小さな出発点です。

なぜスクリプトテンプレートを使うのか？

テンプレートは、チームがバックアップ、デプロイ、レポート、ログクリーンアップ、データ移動などのために多くの小さなスクリプトを作成する場合に役立ちます。テンプレートがないと、各スクリプトはエラー処理、オプション、ログ出力が少しずつ異なる傾向があります。

再利用可能なテンプレートは以下を提供します：

• 一貫した厳格モードとクォートの習慣。
• 標準的なusage関数。
• ログヘルパーの一元管理。
• 一時ファイルとロック用のクリーンアップフック。
• getoptsによる予測可能なコマンドライン解析。

コアテンプレートの構成要素

Bash自体から始め、厳格な動作を有効にします：

#!/usr/bin/env bash
set -euo pipefail

set -eは多くの未処理のコマンド失敗で終了し、set -uは未設定の変数をエラーとして扱い、set -o pipefailはパイプライン内の失敗をキャッチします。予期される失敗に対しては明示的なチェックが必要ですが、厳格モードは多くの偶発的なミスをキャッチします。

スクリプト名と短い使用方法ブロックを追加します：

readonly SCRIPT_NAME="$(basename "$0")"

usage() {
    cat <<USAGE
使用方法: $SCRIPT_NAME [-v] [-o output_dir] input_file

オプション:
  -v              詳細なログ出力を有効にする
  -o output_dir   出力をこのディレクトリに書き込む
  -h              このヘルプメッセージを表示する
USAGE
}

散在するecho呼び出しの代わりに小さなログヘルパーを使用します：

log_info() {
    [[ "$VERBOSE" -eq 1 ]] && printf '[INFO] %s\n' "$1"
}

die() {
    printf '[ERROR] %s\n' "$1" >&2
    exit 1
}

スクリプトが一時ファイルやロックファイルを作成する場合は、早期にクリーンアップ関数を追加します：

cleanup() {
    # 一時ファイルを削除するか、ロックを解放します。
    :
}

trap cleanup EXIT

getoptsによる安全な引数解析

ほとんどの再利用可能なテンプレートにはフラグが必要です。Bashの組み込みgetoptsは、-vや-o output_dirのような短いオプションには十分です。

VERBOSE=0
OUTPUT_DIR="."

while getopts ":vo:h" opt; do
    case "$opt" in
        v) VERBOSE=1 ;;
        o) OUTPUT_DIR=$OPTARG ;;
        h) usage; exit 0 ;;
        :) die "オプション -$OPTARG には引数が必要です" ;;
        \?) die "不明なオプション: -$OPTARG" ;;
    esac
done
shift "$((OPTIND - 1))"

INPUT_FILE=${1:-}
[[ -n "$INPUT_FILE" ]] || { usage >&2; exit 1; }
[[ -f "$INPUT_FILE" ]] || die "入力ファイルが見つかりません: $INPUT_FILE"

":vo:h"の先頭の:により、スクリプトが欠落したオプション引数を自分で処理できるようになります。解析後、shift "$((OPTIND - 1))"で解析済みのオプションを削除し、位置引数を読みやすくします。

再利用可能なコンパクトなテンプレート

以下は、小さな運用スクリプトのための実用的な出発点です：

#!/usr/bin/env bash
set -euo pipefail

readonly SCRIPT_NAME="$(basename "$0")"
VERBOSE=0
OUTPUT_DIR="."

usage() {
    cat <<USAGE
使用方法: $SCRIPT_NAME [-v] [-o output_dir] input_file
USAGE
}

log_info() {
    [[ "$VERBOSE" -eq 1 ]] && printf '[INFO] %s\n' "$1"
}

die() {
    printf '[ERROR] %s\n' "$1" >&2
    exit 1
}

cleanup() {
    :
}
trap cleanup EXIT

while getopts ":vo:h" opt; do
    case "$opt" in
        v) VERBOSE=1 ;;
        o) OUTPUT_DIR=$OPTARG ;;
        h) usage; exit 0 ;;
        :) die "オプション -$OPTARG には引数が必要です" ;;
        \?) die "不明なオプション: -$OPTARG" ;;
    esac
done
shift "$((OPTIND - 1))"

INPUT_FILE=${1:-}
[[ -n "$INPUT_FILE" ]] || { usage >&2; exit 1; }
[[ -f "$INPUT_FILE" ]] || die "入力ファイルが見つかりません: $INPUT_FILE"
mkdir -p "$OUTPUT_DIR"

log_info "$INPUT_FILE を処理中"
# ここにスクリプトのロジックを追加します。

テンプレートは短く保ちます。共有関数は、複数のスクリプトで本当に必要な場合にのみ追加します。テンプレートは繰り返しのセットアップ作業を削除するものであり、すべてのスクリプトをフレームワークのように感じさせるものではありません。