シェルスクリプトテンプレート

プロフェッショナルなコマンドラインツールを作成するための、カラー化された出力フォーマットとユーティリティ関数を備えたモダンなBashスクリプトテンプレート。

特徴

🎨 カラー化された出力: 事前定義されたカラースキームとフォーマット関数
📝 標準化されたメッセージ: 一貫した情報、成功、警告、エラーメッセージフォーマット
🔧 ユーティリティ関数: 一般的なシェルスクリプト操作のためのすぐに使える関数
📦 モジュール設計: プロジェクト間で簡単に再利用できる独立したライブラリファイル
⚡ 簡単セットアップ: 即時使用のためのシンプルなソースメカニズム

クイックスタート

このテンプレートをクローンまたはダウンロード
スクリプトを実行可能にする:
```
chmod +x script.sh
```
サンプルスクリプトを実行:
```
./script.sh
```

使い方

基本テンプレート構造

#!/bin/bash

LIB="lib"
source $LIB/format.sh

section "Your Script Section"
info "Information message"
ok "Success message" 
warn "Warning message"
error "Error message"

利用可能な関数

メッセージタイプ

info "message" - シアン色の [i] プレフィックスで情報メッセージを表示
ok "message" - 緑色の [+] プレフィックスで成功メッセージを表示
warn "message" - 黄色の [!] プレフィックスで警告メッセージを表示
error "message" - 赤色の [-] プレフィックスでエラーメッセージを表示（stderrに出力）

対話型関数

prompt "question" - マゼンタ色の [?] プレフィックスでプロンプトを表示し、ユーザー入力を待機
section "title" - フォーマットされたセクションヘッダーを作成

テキストフォーマット

bold "text" - 太字のテキストを表示

色定数

以下の色定数がカスタムフォーマット用に利用可能です:

RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
BLUE='\033[0;34m'
MAGENTA='\033[0;35m'
CYAN='\033[0;36m'
WHITE='\033[1;37m'
BOLD='\033[1m'
UNDERLINE='\033[4m'
RESET='\033[0m'

出力例

サンプルスクリプトを実行すると、以下のように表示されます:

=== Start ===
[i] Running exploit setup...
[+] Everything is ready
[!] This might break your system
[-] Something failed
[?] Continue? [y/N]:

ファイル構造

shell_template/
├── script.sh          # Example script demonstrating usage
├── lib/
│   └── format.sh       # Core formatting library
├── LICENSE             # MIT License
└── README.md          # This file

カスタマイズ

新しいメッセージタイプの追加

lib/format.sh に新しいメッセージタイプを追加してライブラリを拡張できます:

DEBUG="${BLUE}[D]${RESET}"
debug() { echo -e "${DEBUG} $*"; }

カスタムカラー

色定数を変更するか、新しく作成して独自のカラースキームを定義してください:

PURPLE='\033[0;35m'
CUSTOM_PREFIX="${PURPLE}[*]${RESET}"
custom() { echo -e "${CUSTOM_PREFIX} $*"; }

ベストプラクティス

常にライブラリをソースする: スクリプトの先頭に source $LIB/format.sh を含める
適切なメッセージタイプを使用する: コンテキストに応じた関数（info, ok, warn, error）を選択する
セクションで構造化する: section を使用してスクリプト出力を整理する
エラーを適切に処理する: エラーメッセージには error を使用し、stderr にリダイレクトする
スクリプトを実行可能にする: スクリプトに chmod +x を忘れずに

貢献

Issueの提出、リポジトリのフォーク、プルリクエストの作成は自由です。改善をお待ちしております。

ライセンス

このプロジェクトはMITライセンスのもとでライセンスされています。詳細はLICENSEファイルを参照してください。

作成者

作成者: Christoph Huy

cve_2022_0492

人気