# 通知設計書 15-未知オプション通知

## 概要

本ドキュメントは、space-vimのインストールスクリプト（install.sh）において、不明なコマンドラインオプションが指定された場合に表示されるヘルプメッセージの設計を記載する。

### 本通知の処理概要

未知オプション通知は、ユーザーがインストールスクリプトに認識されないコマンドラインオプションを指定した際に、エラーメッセージとヘルプ情報を表示してスクリプトを終了する機能である。

**業務上の目的・背景**：コマンドラインツールとして、ユーザーが誤ったオプションを指定した場合に適切なフィードバックを提供することは重要である。この通知により、ユーザーは正しいオプションを確認でき、意図した通りにスクリプトを実行できる。

**通知の送信タイミング**：スクリプトの引数解析ループ（35-51行目）において、認識されないオプションが検出された時点で即座に表示される。

**通知の受信者**：インストールスクリプトを実行しているターミナルユーザー。標準出力（stdout）に出力されるため、スクリプト実行者が直接確認する。

**通知内容の概要**：「unknown option: [オプション名]」というエラーメッセージの後に、使用可能なオプション一覧（--help, --all, --vim, --neovim, --update）を含むヘルプメッセージが表示される。

**期待されるアクション**：ユーザーはヘルプメッセージを確認し、正しいオプションを指定してスクリプトを再実行する。

## 通知種別

ターミナル標準出力（CLI通知）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 高 |
| リトライ | 無し（即座に終了） |

### 送信先決定ロジック

スクリプト実行者のターミナルセッション（stdout）に直接出力される。送信先の動的決定は行わない。

## 通知テンプレート

### ターミナル出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | stdout（標準出力） |
| 形式 | プレーンテキスト |

### 本文テンプレート

```
unknown option: ${オプション名}
usage: $0 [OPTIONS]

    --help               Show this message
    --all                Install space-vim for Vim and NeoVim
    --vim                Install space-vim for Vim
    --neovim             Install space-vim for NeoVim
    --update             Update space-vim
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $opt | 不明なオプション名 | コマンドライン引数 | Yes |
| $0 | スクリプト名 | シェル変数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| シェルスクリプト実行 | 不明オプション検出 | case文のデフォルトケース（*）にマッチ | 引数解析ループ内（45-49行目） |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 有効なオプションのみ指定 | --help, --all, --vim, --neovim, --updateのいずれかのみ指定された場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[引数解析開始] --> B{オプション判定}
    B -->|--help| C[help関数呼び出し、exit 0]
    B -->|--all/--vim/--neovim/--update| D[フラグ設定、継続]
    B -->|認識されないオプション| E[echo "unknown option: $opt"]
    E --> F[help関数呼び出し]
    F --> G[exit 1でスクリプト終了]
```

## データベース参照・更新仕様

### 参照テーブル一覧

該当なし（ファイルシステムベースの処理）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 不明オプション | case文のデフォルトケースにマッチ | ヘルプメッセージを表示して終了 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（即座に終了、リトライなし） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（スクリプト実行時に即座に出力）

## セキュリティ考慮事項

- 機密情報は含まれない
- ローカルターミナルへの出力のみで外部通信なし
- ユーザー入力（オプション名）をそのまま出力するが、シェルエスケープの問題は発生しない

## 備考

- help関数は23-33行目で定義されている
- 引数解析ループは35-51行目で実装されている
- exit 1により異常終了ステータスでスクリプトが終了する
- ヒアドキュメント（EOF）を使用してヘルプメッセージを構成している

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

コマンドライン引数`$@`と各引数`$opt`が使用される。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | install.sh | `install.sh` | 引数解析ループ（35-51行目）を確認 |

**読解のコツ**: `for opt in "$@"`は全てのコマンドライン引数を順番に処理する。`case $opt in`でパターンマッチングを行う。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | install.sh | `install.sh` | 引数解析ループ（35-51行目）から処理フローを追跡 |

**主要処理フロー**:
1. **35行目**: `for opt in "$@"; do` - 引数ループ開始
2. **36行目**: `case $opt in` - パターンマッチング開始
3. **45-49行目**: デフォルトケース（*）- 不明オプション処理

#### Step 3: help関数の実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | install.sh | `install.sh` | help関数定義（23-33行目） |

**主要処理フロー**:
- **23-33行目**: help関数 - ヒアドキュメントでヘルプメッセージを出力

#### Step 4: 不明オプション処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | install.sh | `install.sh` | デフォルトケース（45-49行目） |

**主要処理フロー**:
- **46行目**: `echo "unknown option: $opt"` - エラーメッセージ出力
- **47行目**: `help` - ヘルプ関数呼び出し
- **48行目**: `exit 1` - 異常終了

### プログラム呼び出し階層図

```
引数解析ループ (35-51行目)
    |
    +-- case: --help (37-40行目)
    |       +-- help (23-33行目)
    |       +-- exit 0
    |
    +-- case: --all/--vim/--neovim/--update (41-44行目)
    |       +-- フラグ設定
    |
    +-- case: * (45-49行目) [デフォルト]
            +-- echo "unknown option: $opt"
            +-- help (23-33行目)
            +-- exit 1
```

### データフロー図

```
[入力]               [処理]                    [出力]

コマンドライン引数 ──▶ case文でパターンマッチ ──▶ stdout (ターミナル)
    ($@)                    |
                    認識されない場合:
                    1. エラーメッセージ
                    2. help関数呼び出し
                    3. exit 1
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| install.sh | `install.sh` | ソース | インストールスクリプト本体。help関数と引数解析ループを含む |
