# 通知設計書 4-ファイル変更検知通知

## 概要

本ドキュメントは、Babel CLIの監視モードでファイル変更を検知した際に、変更イベントをコンソールへ通知する機能について設計内容を記載する。この通知はverboseモード時のみ有効である。

### 本通知の処理概要

この通知は、`babel` コマンドに `--watch` および `--verbose` オプションを指定して実行した際に、監視対象ファイルの変更イベントを検知したことを知らせる機能である。

**業務上の目的・背景**：開発者がBabelのウォッチモードを使用している際、どのファイルが変更されて再コンパイルがトリガーされたかを把握したい場合がある。通常モードでは変更の検知は暗黙的に行われるが、verboseモードでは変更イベントの種類と対象ファイルを詳細に確認できる。これはデバッグ時や、意図しないファイル変更による再コンパイルの原因を特定する際に有用である。

**通知の送信タイミング**：chokidarによるファイル監視で「change」または「add」イベントが発火した時点で送信される。

**通知の受信者**：コマンドを実行した開発者（標準出力を監視しているユーザー）

**通知内容の概要**：「{イベント種別} {ファイルパス}」形式で、変更イベントの種類（change/add）と対象ファイルのパスが出力される。

**期待されるアクション**：開発者は、この通知を見ることで、どのファイルの変更によって再コンパイルがトリガーされたかを確認できる。ファイル監視が正常に動作しているかの確認にも利用できる。

## 通知種別

コンソール出力（標準出力：stdout）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（console.log） |
| 優先度 | 低（デバッグ用） |
| リトライ | なし |

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

標準出力（stdout）に固定。特定の送信先決定ロジックはなく、プロセスの標準出力に直接出力される。

## 通知テンプレート

### コンソール通知の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | 標準出力（stdout） |
| フォーマット | プレーンテキスト |

### 本文テンプレート

```
{event} {cause}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| event | イベント種別（change/add） | chokidarイベントの種類 | Yes |
| cause | 変更されたファイルの絶対パス | chokidarから渡されるファイルパス | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ファイル変更 | chokidarの「change」イベント | `--verbose`オプションが指定されていること | ファイル内容が変更された時 |
| ファイル追加 | chokidarの「add」イベント | `--verbose`オプションが指定されていること | 新しいファイルが追加された時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `--verbose`オプション未指定 | verboseモードでない場合は通知されない |
| actionableChangeがfalse | 対象ファイルがコンパイル可能な拡張子でない場合 |
| イベント種別がchange/add以外 | unlinkなど他のイベントでは通知されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[watcher.onFilesChange登録] --> B[ファイル変更検知]
    B --> C{イベント種別}
    C -->|change/add| D[コールバック関数呼び出し]
    C -->|その他| E[イベント無視]
    D --> F{actionableChange?}
    F -->|No| G[処理スキップ]
    F -->|Yes| H{--verbose指定?}
    H -->|Yes| I[console.log出力]
    H -->|No| J[通知スキップ]
    I --> K[walk関数でコンパイル実行]
    J --> K
    G --> L[終了]
    K --> L
    E --> L
```

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

該当なし（データベースを使用しない）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| walk関数内でのエラー | コンパイル処理でエラー発生 | catchブロックでエラーを標準エラー出力に表示 |

### リトライ仕様

リトライなし

## 配信設定

### レート制限

該当なし（イベント発生時に都度出力）

### 配信時間帯

制限なし

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

ファイルパスが出力されるため、ディレクトリ構造が外部に漏洩する可能性がある。ただし、ローカル開発環境での使用を想定しているため、通常は問題とならない。

## 備考

- この通知はファイルモード（file.ts）でのウォッチ処理で使用される
- ディレクトリモード（dir.ts）では別の処理フローが使用される
- chokidarのイベントはファイルシステムの変更を検知するため、エディタの自動保存機能などでも発火する可能性がある

---

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

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

### 推奨読解順序

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

この通知に関わるデータ構造は、chokidarのイベントデータである。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | watcher.ts | `packages/babel-cli/src/babel/watcher.ts` | onFilesChange関数のコールバック引数を確認（66-84行目） |

**読解のコツ**: コールバック関数の引数は`(filenames: string[], event: string, cause: string)`の3つ。eventはchokidarのイベント名、causeは変更されたファイルパス。

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

ファイル変更検知の処理フローを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | file.ts | `packages/babel-cli/src/babel/file.ts` | files関数内のウォッチモード処理（219-240行目） |

**主要処理フロー**:
1. **224行目**: `watcher.onFilesChange`でコールバック登録
2. **225-230行目**: actionableChangeの判定
3. **232-233行目**: verboseモード時のconsole.log出力
4. **236-238行目**: walk関数でコンパイル実行とエラーハンドリング

#### Step 3: 通知条件の詳細を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | file.ts | `packages/babel-cli/src/babel/file.ts` | verboseチェックとconsole.log（232-233行目） |

**主要処理フロー**:
- **232行目**: `if (cliOptions.verbose)` でverboseモードを判定
- **233行目**: `console.log(\`${event} ${cause}\`)` でイベント情報を出力

#### Step 4: watcher.tsのイベント処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | watcher.ts | `packages/babel-cli/src/babel/watcher.ts` | onFilesChange関数の内部実装（66-85行目） |

**主要処理フロー**:
- **75行目**: `watcher.on("all", (event, filename) => {...})`でイベント監視
- **76行目**: changeとadd以外のイベントは早期リターン
- **78-83行目**: 変更ファイルと依存ファイルを含む配列でコールバック呼び出し

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

```
babel CLI (main)
    │
    └─ file.ts default export function
           │
           └─ files()
                  │
                  ├─ watcher.enable()
                  │
                  ├─ watcher.watch()
                  │
                  ├─ watcher.startWatcher()
                  │
                  └─ watcher.onFilesChange(callback)
                         │
                         └─ chokidar "all" イベント
                                │
                                ├─ [change/add] callback呼び出し
                                │      │
                                │      ├─ actionableChange判定
                                │      │
                                │      ├─ [verbose] console.log(event, cause)
                                │      │
                                │      └─ walk()
                                │
                                └─ [その他] 早期リターン
```

### データフロー図

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

ファイル変更イベント ───────▶ chokidar FSWatcher
                                   │
                                   ▼
                           watcher.on("all")
                                   │
                                   ▼
                           イベントフィルタリング
                           (change/addのみ)
                                   │
                                   ▼
                           onFilesChangeコールバック
                                   │
                                   ▼
                           [verbose && actionable]
                                   │
                                   ▼
   event + cause ───────────▶ console.log ───────▶ stdout: "change /path/to/file"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| file.ts | `packages/babel-cli/src/babel/file.ts` | ソース | ファイルモードのコンパイル処理と通知 |
| watcher.ts | `packages/babel-cli/src/babel/watcher.ts` | ソース | ファイル監視とイベント処理 |
| options.ts | `packages/babel-cli/src/babel/options.ts` | ソース | `--verbose`と`--watch`オプションの定義 |
| util.ts | `packages/babel-cli/src/babel/util.ts` | ソース | isCompilableExtension関数の実装 |
