# 通知設計書 4-zbell - コマンド完了ベル音

## 概要

本ドキュメントは、Oh My Zshのzbellプラグインにおけるコマンド完了時のベル音通知機能について、その設計仕様を定義するものである。

### 本通知の処理概要

zbellプラグインは、コマンドの実行時間が指定したしきい値（デフォルト15秒）を超えた場合に、ターミナルベル音を鳴らす機能を提供する。bgnotifyプラグインとは異なり、ターミナルがフォアグラウンドにあってもベル音が鳴る。

**業務上の目的・背景**：長時間実行されるコマンド（コンパイル、テスト、データ処理など）を実行した際、ユーザーは他の作業に集中していることが多い。コマンド完了時にベル音で通知することで、ターミナルを常時監視する必要がなくなり、作業効率が向上する。zbellはzshビルトインのみを使用するため、外部依存がなく軽量である。

**通知の送信タイミング**：コマンドの実行が完了し、かつ実行時間がzbell_duration（デフォルト15秒）以上であり、コマンドがzbell_ignoreリストに含まれていない場合にベル音が出力される。

**通知の受信者**：コマンドを実行したユーザー自身。ターミナルエミュレータを通じて音声が出力される。

**通知内容の概要**：ASCII BEL文字（\a、0x07）が標準出力に書き込まれ、ターミナルエミュレータがこれをシステムの警告音として再生する。

**期待されるアクション**：受信者はベル音を聞いてコマンドの完了を認識し、必要に応じてターミナルを確認して次の作業に移る。

## 通知種別

ターミナルベル（システム警告音）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（print -n \a による即時出力） |
| 優先度 | 中 |
| リトライ | 無し |

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

ベル音は標準出力に対して出力されるため、現在のターミナルセッションで出力される。ベル音の実際の再生はターミナルエミュレータの設定に依存する。

## 通知テンプレート

### ベル音の場合

| 項目 | 内容 |
|-----|------|
| 出力文字 | `\a`（ASCII BEL、0x07） |
| 出力方法 | `print -n "\a"` |

### 本文テンプレート

```
\a
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| N/A | - | - | 添付ファイルなし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| zbell_duration | 通知しきい値（秒） | シェル変数 | Yes（デフォルト15） |
| zbell_ignore | 無視するコマンドリスト | シェル変数 | No（デフォルト$EDITOR $PAGER） |
| zbell_lastcmd | 最後に実行されたコマンド | preexecフック | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| シェルフック | precmd（プロンプト表示直前） | 実行時間 >= zbell_duration かつ コマンドがzbell_ignoreに含まれない | コマンド完了時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 実行時間がしきい値未満 | cmd_duration < zbell_duration（デフォルト15秒） |
| 無視リストに含まれる | コマンドがzbell_ignore配列に含まれる場合 |
| 空コマンド | コマンドが空の場合 |
| 重複実行防止 | 同じタイムスタンプで既に実行済みの場合 |
| 非インタラクティブシェル | 対話モードでない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[preexec: コマンド実行開始] --> B[タイムスタンプ記録]
    B --> C[コマンド実行]
    C --> D[precmd: コマンド完了]
    D --> E{同じタイムスタンプで実行済み?}
    E -->|Yes| F[終了]
    E -->|No| G{コマンドが空?}
    G -->|Yes| F
    G -->|No| H{実行時間 >= しきい値?}
    H -->|No| F
    H -->|Yes| I{コマンドが無視リストに含まれる?}
    I -->|Yes| F
    I -->|No| J[zbell_notify呼び出し]
    J --> K[zbell_ui_notify]
    K --> L[print -n '\a']
    L --> F
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない。シェル変数のみで状態管理を行う。

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| N/A | - | データベース不使用 |

### シェル変数一覧

| 変数名 | 用途 | デフォルト値 |
|--------|------|-------------|
| zbell_duration | 通知しきい値（秒） | 15 |
| zbell_ignore | 無視するコマンドリスト | ($EDITOR $PAGER) |
| zbell_timestamp | コマンド開始時刻 | EPOCHSECONDS |
| zbell_lastcmd | 最後に実行したコマンド | preexec引数 |
| zbell_last_timestamp | 最後に通知したタイムスタンプ | 前回通知時のタイムスタンプ |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 音声出力無効 | システムの音声がミュートされている | ターミナルエミュレータ/OSの仕様に依存 |
| zsh/datetime ロード失敗 | zmodloadが失敗 | プラグインが読み込まれない（returnで終了） |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし（ただし同一タイムスタンプでの重複は防止） |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（24時間対応）

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

- ベル音は情報を含まないため、セキュリティ上の懸念はない
- ローカル出力のみであり、ネットワーク経由での送信は行われない
- zshビルトインのみを使用するため、外部コマンドへの依存がない

## 備考

- zbell_ignoreにはデフォルトで$EDITORと$PAGERが設定されており、エディタやページャーの終了時には通知されない
- sudoプレフィックスは自動的に除去してコマンドを判定する
- パイプやセミコロンで連結されたコマンドは分割して各コマンドを判定する
- bgnotifyとは異なり、ターミナルがフォアグラウンドでも通知される

---

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

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

### 推奨読解順序

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

プラグインで使用されるシェル変数とその役割を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | zbell.plugin.zsh | `plugins/zbell/zbell.plugin.zsh` | 26-33行目の変数初期化でデフォルト値を確認 |

**読解のコツ**: `(( ${+var} ))` は変数が設定されているかをチェックする記法。設定されていない場合にデフォルト値を設定する。

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

処理の起点となるフック登録を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | zbell.plugin.zsh | `plugins/zbell/zbell.plugin.zsh` | 94-96行目のadd-zsh-hookでpreexec/precmdフック登録を確認 |

**主要処理フロー**:
1. **95行目**: `add-zsh-hook preexec zbell_begin` - コマンド実行前フック
2. **96行目**: `add-zsh-hook precmd zbell_end` - プロンプト表示前フック

#### Step 3: コマンド開始処理を理解する

preexecフックで呼ばれるzbell_begin関数を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | zbell.plugin.zsh | `plugins/zbell/zbell.plugin.zsh` | 61-64行目のzbell_begin関数でタイムスタンプとコマンドの記録を理解 |

**主要処理フロー**:
- **62行目**: `zbell_timestamp=$EPOCHSECONDS` - 開始時刻記録
- **63行目**: `zbell_lastcmd=$1` - 実行コマンド記録

#### Step 4: コマンド完了処理を理解する

precmdフックで呼ばれるzbell_end関数を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | zbell.plugin.zsh | `plugins/zbell/zbell.plugin.zsh` | 68-92行目のzbell_end関数で条件判定と通知呼び出しの流れを理解 |

**主要処理フロー**:
- **69行目**: `local cmd_duration=$(( $EPOCHSECONDS - $zbell_timestamp ))` - 実行時間計算
- **70行目**: `local ran_long=$(( $cmd_duration >= $zbell_duration ))` - しきい値チェック
- **73行目**: sudoプレフィックスの除去
- **75行目**: 重複実行防止チェック
- **81-89行目**: 無視リストチェック
- **91行目**: `zbell_notify` 呼び出し

#### Step 5: 通知処理を理解する

実際にベル音を出力する処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | zbell.plugin.zsh | `plugins/zbell/zbell.plugin.zsh` | 55-58行目のzbell_notify関数でベル音出力を確認 |

**主要処理フロー**:
- **56行目**: `zbell_ui_notify "${@}"` - UI通知呼び出し（オプション）
- **57行目**: `print -n "\a"` - ベル音出力

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

```
[シェル起動]
    │
    ├─ プラグインロード (zbell.plugin.zsh)
    │      ├─ zmodload zsh/datetime (18行目)
    │      ├─ autoload -Uz add-zsh-hook (21行目)
    │      ├─ autoload -Uz regexp-replace (24行目)
    │      ├─ 変数初期化 (26-39行目)
    │      ├─ add-zsh-hook preexec zbell_begin (95行目)
    │      └─ add-zsh-hook precmd zbell_end (96行目)
    │
[コマンド実行開始]
    │
    ├─ zbell_begin (preexecフック)
    │      └─ タイムスタンプ・コマンド記録
    │
[コマンド実行完了]
    │
    └─ zbell_end (precmdフック)
           ├─ 実行時間計算
           ├─ sudoプレフィックス除去
           ├─ 重複チェック
           ├─ 無視リストチェック
           └─ zbell_notify
                  ├─ zbell_ui_notify (オプション)
                  └─ print -n "\a" ──▶ ベル音
```

### データフロー図

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

EPOCHSECONDS ─────────▶ zbell_begin ──────────────▶ zbell_timestamp
preexec引数 ──────────▶                           ▶ zbell_lastcmd

                        zbell_end
zbell_timestamp ──────▶ ├─ 実行時間計算
zbell_lastcmd ────────▶ ├─ sudoプレフィックス除去
zbell_duration ───────▶ ├─ しきい値チェック
zbell_ignore ─────────▶ ├─ 無視リストチェック
                        └─ zbell_notify ───────────▶ '\a' (ベル音)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| zbell.plugin.zsh | `plugins/zbell/zbell.plugin.zsh` | ソース | メインプラグインファイル、全てのベル音通知ロジックを含む |
