コマンド単位の使い方ではなく、作業効率化のためのスクリプトを書く際などに使えるテクニックをまとめてみました。
便利なものがあれば随時追加していきます。
[目次]
エラー対策
使用例
- ほとんどのケースでつけておいて損がないエラー対策です
使用コマンド
- set
- Set Builtin
set -e
set -u
set -o
pipefail
- シェルオプション
- パイプで繋がれた中にエラーがあれば終了する
set -euo pipefail
ファイル内容のコメント
個人的に、以下のようにファイルの目的・使用方法をファイルの先頭に書くようにしています。
オプション引数をパースする
使用コマンド
- 「全ての引数」を表す特殊変数
$@をループで処理しています
注意点
-n 2などのように『オプション + 値』を取るような場合は注意が必要です
for i in "$@"; do
case $i in
-h | --help | -help)
usage_and_exit 0
;;
-s | --slide)
is_slide=true
shift 1
;;
-o | --output)
if [[ -z "$2" ]]; then
echo "option requires a file name -- $1"
usage_and_exit 1
fi
OUTPUT_PATH="$2"
shift 2
;;
-*)
echo "Unknown option $1"
usage_and_exit 1
;;
*)
// 何も指定がなければファイル名として解釈したい場合
if [[ -n "$1" ]] && [[ -f "$1" ]]; then
FILE="$1"
shift 1
fi
;;
esac
done
カスタマイズされたエラーメッセージ
使用例
- 一部分だけ赤文字にしたエラーメッセージを表示します
- 標準エラー出力にしています
function print_error() {
ERROR='\033[1;31m'
NORMAL='\033[0m'
echo -e "${ERROR}ERROR${NORMAL}: $1" >&2
}
if [ ! -f "$FILE" ]; then
print_error "File $FILE doesn't exist"
fi
ファイル終了時に後処理を行う
使用例
- 途中で処理が失敗したら、事前に作成しておいたバックアップファイルからの復元を行う
使用コマンド
注意点
// ファイル終了時に呼び出したい関数を定義する
function recover_from_backup() {
EXIT_CODE="$?"
// 終了コードが 0 より大きい場合、エラー終了したことを意味する
if [[ "$EXIT_CODE" -gt 0 ]]; then
echo "Something went wrong."
echo "recovered from backup"
else
echo "Exit correctly"
fi
}
trap recover_from_backup EXIT
helpを表示する
使用例
- コマンドの使い方及び
-hオプションを渡されたときの出力例です
PROGRAM="$(basename "$0")"
function print_usage() {
echo "Usage: $PROGRAM [OPTION] FILE"
echo " -h, --help, -help"
echo " print manual"
echo " -o <filename>, --output <filename>"
echo " output filename"
}
help を表示して終了：ただし終了ステータスを変えたい
使用例
- コマンドの使用方法（help）を表示 + 実行終了を行いたいが、終了コードを使い分けたい
--helpオプションに対しては 0（正常終了）- ファイルが存在しない等のエラーに対しては 1（異常終了）
usage_and_exit()
{
print_usage
exit "$1"
}
usage_and_exit 0
usage_and_exit 1
特定のファイルに対して１行ごとに処理を行う
while read -r line
do
echo "$line"
done < "$FILE"
変数が正規表現に一致してるかチェック
注意点
if [[ "$line" =~ ^\`\`\`.* ]]; then
echo "Code block start (or end)"
fi
おわりに
スクリプトを書く際はテンプレに沿うケースが多いと思って、自分がよく使うものをまとめてみました。何か一つでも良いと思っていただけたら嬉しいです。
