# 通知設計書 11-インストール成功通知

## 概要

本ドキュメントは、space-vimのインストールスクリプト（install.sh）において、各処理ステップが正常に完了した際に表示される成功通知（success関数）の設計を記載する。

### 本通知の処理概要

インストール成功通知は、space-vimのインストールプロセスにおける各ステップの完了をユーザーに視覚的にフィードバックするための通知機能である。

**業務上の目的・背景**：インストールプロセスは複数のステップ（リポジトリのクローン、vim-plugのダウンロード、シンボリックリンクの作成、プラグインのインストールなど）で構成されており、各ステップの成功/失敗をユーザーが即座に判断できることが重要である。この通知により、ユーザーはインストールの進捗を把握し、問題発生時の切り分けが容易になる。

**通知の送信タイミング**：各処理ステップが正常に完了した直後（`ret="$?"`で終了ステータスが0の場合）にsuccess関数が呼び出され、通知が表示される。

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

**通知内容の概要**：緑色のチェックマーク記号（[✔]）とともに、完了した処理の説明メッセージが表示される。ANSIエスケープシーケンスを使用して視覚的に成功を強調する。

**期待されるアクション**：ユーザーは成功通知を確認することで、インストールが正常に進行していることを認識し、次のステップの完了を待つか、インストール完了後にspace-vimの利用を開始する。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中 |
| リトライ | 無し |

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr（標準エラー出力） |
| 形式 | ANSIカラーエスケープシーケンス付きテキスト |

### 本文テンプレート

```
\33[32m[✔]\33[0m ${メッセージ}${追加情報}
```

- `\33[32m` : 緑色開始
- `[✔]` : チェックマーク記号
- `\33[0m` : 色リセット
- `${メッセージ}` : 成功メッセージ本文
- `${追加情報}` : オプションの追加情報

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | メッセージ本文 | 関数呼び出し時の第1引数 | Yes |
| $2 | 追加情報 | 関数呼び出し時の第2引数 | No |
| $ret | 直前コマンドの終了ステータス | シェル変数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| シェルスクリプト実行 | リポジトリクローン完了 | $ret -eq 0 | sync_repo関数内 |
| シェルスクリプト実行 | リポジトリ更新完了 | $ret -eq 0 | sync_repo関数内 |
| シェルスクリプト実行 | vim-plugダウンロード完了 | $ret -eq 0 | install_for_vim/install_for_neovim関数内 |
| シェルスクリプト実行 | .spacevim生成完了 | $ret -eq 0 | generate_dot_spacevim関数内 |
| シェルスクリプト実行 | プラグインインストール完了 | $ret -eq 0 | install_plugins関数内 |
| シェルスクリプト実行 | 設定バックアップ完了 | $ret -eq 0 | backup関数内 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| $ret -ne 0 | 直前のコマンドが失敗した場合、success関数内のif文により通知は出力されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[処理ステップ実行] --> B[終了ステータス取得 ret=$?]
    B --> C[success関数呼び出し]
    C --> D{ret == 0?}
    D -->|Yes| E[ANSIカラー付きメッセージ生成]
    D -->|No| F[何も出力しない]
    E --> G[msg関数でstderrに出力]
    G --> H[終了]
    F --> H
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 出力失敗 | stderrへの書き込み不可 | シェルの標準動作に依存 |
| 文字化け | ターミナルがANSIエスケープ非対応 | 表示が乱れるが機能には影響なし |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 機密情報は含まれない
- ローカルターミナルへの出力のみで外部通信なし
- ANSIエスケープシーケンスによる表示制御のみ

## 備考

- success関数は60-64行目で定義されている
- msg関数を内部で使用してstderrに出力する
- 緑色（\\33[32m）でチェックマーク記号を表示し、視覚的な成功フィードバックを提供する

---

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

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

### 推奨読解順序

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

本通知はシンプルなシェルスクリプトの関数であり、複雑なデータ構造は使用していない。変数として`ret`（終了ステータス）と引数`$1`、`$2`を使用する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | install.sh | `install.sh` | グローバル変数の定義（13-21行目）を確認 |

**読解のコツ**: シェルスクリプトでは`$?`で直前コマンドの終了ステータスを取得し、変数`ret`に格納するパターンを理解する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | install.sh | `install.sh` | main処理（214-220行目）から処理フローを追跡 |

**主要処理フロー**:
1. **214行目**: check_git関数でgitの存在確認
2. **216行目**: sync_repo関数でリポジトリのクローン/更新
3. **218行目**: install関数でインストール処理実行
4. **220行目**: 完了メッセージ表示

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | install.sh | `install.sh` | success関数定義（60-64行目） |
| 3-2 | install.sh | `install.sh` | msg関数定義（56-58行目） |

**主要処理フロー**:
- **60-64行目**: success関数 - 終了ステータスが0の場合のみメッセージ出力
- **56-58行目**: msg関数 - printf でstderrに出力

#### Step 4: success関数の呼び出し箇所を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | install.sh | `install.sh` | sync_repo関数内（81, 86行目） |
| 4-2 | install.sh | `install.sh` | install_plugins関数内（98行目） |
| 4-3 | install.sh | `install.sh` | generate_dot_spacevim関数内（106行目） |
| 4-4 | install.sh | `install.sh` | backup関数内（118行目） |
| 4-5 | install.sh | `install.sh` | install_for_vim関数内（128行目） |
| 4-6 | install.sh | `install.sh` | install_for_neovim関数内（142行目） |

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

```
main (214-220行目)
    |
    +-- check_git (151-155行目)
    |
    +-- sync_repo (75-91行目)
    |       +-- msg (56-58行目)
    |       +-- success (60-64行目)
    |              +-- msg (56-58行目)
    |
    +-- install (196-209行目)
            +-- install_for_vim (122-134行目)
            |       +-- backup (110-120行目)
            |       |       +-- success
            |       +-- success
            |       +-- generate_dot_spacevim (101-108行目)
            |       |       +-- success
            |       +-- install_plugins (93-99行目)
            |               +-- success
            |
            +-- install_for_neovim (136-149行目)
                    +-- (同様の構造)
```

### データフロー図

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

コマンド終了ステータス ──▶ success関数判定 ──▶ stderr (ターミナル)
       ($?)                    |
                          ret == 0?
                              |
                       Yes: ANSIカラー付き
                            成功メッセージ生成
                              |
                          msg関数で出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| install.sh | `install.sh` | ソース | インストールスクリプト本体。success関数を含むすべての通知関数を定義 |
