# 通知設計書 29-chokidarエラー

## 概要

本ドキュメントは、`@babel/cli`におけるファイル監視ライブラリchokidarのインストール失敗時に出力されるエラーメッセージの設計について記載する。

### 本通知の処理概要

この通知は、Babel CLIのウォッチモード（--watch）を使用する際に、オプション依存のファイル監視ライブラリchokidarがインストールされていないか、現在のプラットフォームでサポートされていない場合に、エラーメッセージを標準エラー出力に出力する機能を提供する。

**業務上の目的・背景**：chokidarはBabel CLIのオプション依存パッケージであり、ウォッチモードを使用する場合のみ必要となる。一部のプラットフォーム（特定のLinuxディストリビューションや特殊な環境）ではchokidarがサポートされていない場合がある。この機能により、chokidarが利用できない場合に明確なエラーメッセージを表示し、ユーザーが問題を理解できるようにする。

**通知の送信タイミング**：`requireChokidar`関数内で`require("chokidar")`が失敗した場合に、キャッチされたエラーの前にconsole.errorでメッセージが出力される。

**通知の受信者**：Babel CLIのウォッチモードを使用しようとしているユーザー、ターミナルを監視している開発者が対象。

**通知内容の概要**：エラーメッセージには、chokidarのインストール失敗とウォッチモードで必要であること、およびプラットフォームでサポートされていない可能性があることが含まれる。

**期待されるアクション**：ユーザーは、手動でchokidarをインストールするか（`npm install chokidar`）、別のプラットフォームでの実行を検討するか、ウォッチモードを使用しない方法に切り替えることが期待される。

## 通知種別

コンソールエラー（console.error）

## 送信仕様

### 基本情報

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

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

標準エラー出力（stderr）に対してconsole.errorで出力される。その後、元のエラーがスローされる。

## 通知テンプレート

### コンソール出力

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr（console.error経由） |
| 形式 | プレーンテキスト |

### 本文テンプレート

```
The optional dependency chokidar failed to install and is required for --watch. Chokidar is likely not supported on your platform.
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | - | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| モジュールロード失敗 | require("chokidar")の失敗 | エラー発生 | ウォッチモード有効化時のchokidar読み込み |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| chokidarが正常にインストールされている | requireが成功した場合 |
| ウォッチモードを使用しない | chokidarが必要ない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ウォッチモード有効化] --> B[enable関数呼び出し]
    B --> C[requireChokidar呼び出し]
    C --> D{require成功?}
    D -->|Yes| E[FSWatcherインスタンス作成]
    D -->|No| F[console.errorでエラーメッセージ出力]
    F --> G[元のエラーをthrow]
    E --> H[ウォッチ開始]
    G --> I[プロセス終了]
    H --> I
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | - | データベースは使用しない |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | データベースは使用しない |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| MODULE_NOT_FOUND | chokidarがインストールされていない | npm install chokidarを実行 |
| プラットフォーム非サポート | chokidarが現在のプラットフォームをサポートしていない | 別の方法を検討 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（モジュールロード時に同期的に出力）

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

- 固定のエラーメッセージのみが出力され、機密情報は含まれない
- システム環境情報は出力されない

## 備考

- chokidarはBabel CLIのオプション依存パッケージであり、package.jsonのoptionalDependenciesに記載されている
- fsevents（chokidarの依存）がmacOS以外ではオプションであるため、一部環境でのインストール失敗が発生する可能性がある
- エラーメッセージ出力後、元のエラーがスローされるため、より詳細なエラー情報も表示される

---

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

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

### 推奨読解順序

#### Step 1: requireChokidar関数を理解する

chokidarの読み込みとエラー処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | watcher.ts | `packages/babel-cli/src/babel/watcher.ts` | requireChokidar関数（150-162行目） |

**読解のコツ**: createRequireを使用してESMからCommonJSモジュールを読み込んでいる。

#### Step 2: エラー処理を理解する

try-catchでのエラー処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | watcher.ts | `packages/babel-cli/src/babel/watcher.ts` | try-catchブロック（153-161行目） |

**主要処理フロー**:
1. **行153**: `try { ... }`でrequireを試行
2. **行154**: `return require("chokidar")`でchokidarを読み込み
3. **行155-161**: `catch (err) { ... }`でエラーをキャッチ
4. **行156-158**: `console.error(...)`でエラーメッセージを出力
5. **行160**: `throw err`で元のエラーをスロー

#### Step 3: enable関数からの呼び出しを理解する

enable関数がrequireChokidarを呼び出す流れを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | watcher.ts | `packages/babel-cli/src/babel/watcher.ts` | enable関数（13-30行目） |

**主要処理フロー**:
- **行16**: `const { FSWatcher } = requireChokidar()`でchokidarを読み込み
- **行27**: `watcher = new FSWatcher(options)`でインスタンスを作成

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

```
babel --watch
    │
    └─ enable({ enableGlobbing: ... })
           │
           └─ requireChokidar()
                  │
                  └─ require("chokidar")
                         │
                         └─ エラー発生
                                │
                                ├─ console.error(message)  ← エラー出力
                                │
                                └─ throw err
```

### データフロー図

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

ウォッチモード要求 ───▶ requireChokidar関数 ───▶ chokidarモジュール or エラー
                              │
                              ▼ (require失敗)
                        console.error ───▶ stderr（エラーメッセージ）
                              │
                              ▼
                        throw err ───▶ 呼び出し元へエラー伝播
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| watcher.ts | `packages/babel-cli/src/babel/watcher.ts` | ソース | ファイル監視機能とchokidar読み込み |
| dir.ts | `packages/babel-cli/src/babel/dir.ts` | ソース | ディレクトリコンパイル処理（watcherを使用） |
| file.ts | `packages/babel-cli/src/babel/file.ts` | ソース | ファイルコンパイル処理（watcherを使用） |
| package.json | `packages/babel-cli/package.json` | 設定 | chokidarのoptionalDependencies定義 |
