# 通知設計書 13-インストール進捗通知

## 概要

本ドキュメントは、space-vimのインストールスクリプト（install.sh）において、処理の進捗状況を表示するmsg関数の設計を記載する。

### 本通知の処理概要

インストール進捗通知は、space-vimのインストールプロセスにおける各ステップの開始や状態をユーザーに通知するための基本的な通知機能である。青色の矢印でメッセージを強調表示する。

**業務上の目的・背景**：インストールプロセスは複数のステップで構成されており、現在どの処理が実行されているかをユーザーが把握できることが重要である。この通知により、ユーザーはインストールの進行状況をリアルタイムで確認でき、処理が停止していないことを認識できる。

**通知の送信タイミング**：各処理ステップの開始時、または状態変化時（例：vim-plugのダウンロード開始、リポジトリのクローン開始など）にmsg関数が直接呼び出されて通知が表示される。

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

**通知内容の概要**：青色の矢印（==>）とともに、現在実行中の処理の説明メッセージが表示される。ANSIエスケープシーケンスを使用して視覚的に進捗を強調する。

**期待されるアクション**：ユーザーは進捗通知を確認することで、インストールが正常に進行していることを認識し、処理の完了を待つ。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
\033[1;34m==>\033[0m ${メッセージ}
```

- `\033[1;34m` : 太字青色開始
- `==>` : 矢印記号
- `\033[0m` : 色リセット
- `${メッセージ}` : 進捗メッセージ本文

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | メッセージ本文 | 関数呼び出し時の第1引数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| シェルスクリプト実行 | リポジトリクローン開始 | 常時 | sync_repo関数内（77行目） |
| シェルスクリプト実行 | リポジトリ更新開始 | 常時 | sync_repo関数内（83行目） |
| シェルスクリプト実行 | vim-plugダウンロード開始 | 常時 | install_for_vim関数内（124行目） |
| シェルスクリプト実行 | vim-plugダウンロード開始 | 常時 | install_for_neovim関数内（138行目） |
| シェルスクリプト実行 | バックアップ開始 | 常時 | backup関数内（113行目） |
| シェルスクリプト実行 | vim/neovim検出通知 | 常時 | infer関数内（159, 183, 187行目） |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | msg関数が呼び出された場合、必ず通知が出力される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[処理ステップ開始] --> B[msg関数呼び出し]
    B --> C[ANSIカラー付きメッセージ生成]
    C --> D[printf でstderrに出力]
    D --> E[処理継続]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- msg関数は56-58行目で定義されている
- `printf '%b\n' "$1" >&2` でstderrに出力する
- `%b`フォーマット指定子によりエスケープシーケンスが解釈される
- success関数とerror関数の内部でも使用される基本的な出力関数

---

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

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

### 推奨読解順序

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | install.sh | `install.sh` | msg関数定義（56-58行目）を確認 |

**読解のコツ**: `>&2`はstderrへのリダイレクトを意味する。`%b`はprintf の書式指定子でバックスラッシュエスケープを解釈する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | install.sh | `install.sh` | main処理（214-220行目）からmsg関数が呼び出されるフローを追跡 |

**主要処理フロー**:
1. **214行目**: check_git関数
2. **216行目**: sync_repo関数 → msg関数呼び出し（77, 83行目）
3. **218行目**: install関数 → install_for_vim/install_for_neovim → msg関数呼び出し

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

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

**主要処理フロー**:
- **57行目**: `printf '%b\n' "$1" >&2` - エスケープシーケンスを解釈してstderrに出力

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | install.sh | `install.sh` | sync_repo関数内（77, 83行目） |
| 4-2 | install.sh | `install.sh` | backup関数内（113行目） |
| 4-3 | install.sh | `install.sh` | install_for_vim関数内（124行目） |
| 4-4 | install.sh | `install.sh` | install_for_neovim関数内（138行目） |
| 4-5 | install.sh | `install.sh` | infer関数内（159, 183, 184, 187, 188行目） |

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

```
main (214-220行目)
    |
    +-- check_git (151-155行目)
    |
    +-- sync_repo (75-91行目)
    |       +-- msg (56-58行目) [77, 83行目]
    |
    +-- install (196-209行目)
            +-- install_for_vim (122-134行目)
            |       +-- backup (110-120行目)
            |       |       +-- msg (56-58行目) [113行目]
            |       +-- msg (56-58行目) [124行目]
            |
            +-- install_for_neovim (136-149行目)
            |       +-- msg (56-58行目) [138行目]
            |
            +-- infer (157-194行目)
                    +-- msg (56-58行目) [159, 183, 184, 187, 188行目]
```

### データフロー図

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

ANSIカラー付き    ──▶ msg関数 ──▶ printf ──▶ stderr (ターミナル)
メッセージ文字列          |
                    '%b\n'で
                    エスケープ解釈
```

### 関連ファイル一覧

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