# 通知設計書 25-コンパイルエラー出力

## 概要

本ドキュメントは、`@babel/cli`におけるディレクトリコンパイル処理中に発生したエラーを標準エラー出力に出力する機能の設計について記載する。

### 本通知の処理概要

この通知は、Babel CLIの`--out-dir`オプションを使用してディレクトリ内のファイルをコンパイルする際に、個別のファイルコンパイルでエラーが発生した場合に、エラー情報を標準エラー出力に出力する機能を提供する。

**業務上の目的・背景**：バッチコンパイル処理では、複数のファイルを連続してコンパイルする。ウォッチモードでは、1つのファイルでエラーが発生しても他のファイルの処理を継続する必要がある。この機能により、エラーが発生したファイルの情報をユーザーに通知しつつ、処理を継続することが可能になる。通常モードでは、エラー時に例外がスローされプロセスが終了する。

**通知の送信タイミング**：`write`関数または`onFilesChange`のコールバック関数内でファイルコンパイル中にエラーがキャッチされた際に、ウォッチモードの場合のみconsole.errorでエラーが出力される。

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

**通知内容の概要**：エラーオブジェクトがそのままconsole.errorに渡されるため、エラーメッセージとスタックトレースが出力される。Babelのコンパイルエラーの場合は、構文エラーの位置情報やコードフレームも含まれる。

**期待されるアクション**：ユーザーは、エラーメッセージの内容を確認し、対象ファイルの構文エラーやコンパイル設定の問題を修正し、ファイルを保存して再コンパイルをトリガーすることが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

標準エラー出力（stderr）に対してconsole.errorで出力される。エラーオブジェクト全体が出力されるため、スタックトレースも含まれる。

## 通知テンプレート

### コンソール出力

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr（console.error経由） |
| 形式 | Errorオブジェクト（スタックトレース含む） |

### 本文テンプレート

```
{Error.message}
{Error.stack}
```

Babelのコンパイルエラーの場合、以下のような形式で出力される：

```
SyntaxError: {ファイルパス}: {エラーメッセージ} ({行番号}:{列番号})

  {行番号-1} | {コード}
> {行番号}   | {エラー箇所のコード}
            | {エラー位置を示すキャレット}
  {行番号+1} | {コード}

    at Parser._raise ...
    (スタックトレース)
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| err | エラーオブジェクト | try-catchでキャッチされたエラー | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル中 | write関数でのコンパイル処理 | ウォッチモードかつエラー発生 | 個別ファイルのコンパイル時（80行目） |
| ファイル変更検知 | onFilesChangeコールバック | エラー発生 | ウォッチモードでのファイル変更検知時（245行目） |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ウォッチモードでない | 通常モードではエラーがスローされ、プロセスが終了する |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[write関数呼び出し] --> B[util.compile実行]
    B --> C{コンパイル成功?}
    C -->|Yes| D[FILE_TYPE.COMPILED返却]
    C -->|No| E{cliOptions.watch?}
    E -->|Yes| F[console.errorでエラー出力]
    F --> G[FILE_TYPE.ERR_COMPILATION返却]
    E -->|No| H[エラーをthrow]
    D --> I[処理継続]
    G --> I
    H --> J[プロセス終了]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| SyntaxError | ソースコードの構文エラー | ファイルを修正して再保存 |
| ConfigError | Babel設定の問題 | babel.config.jsを確認・修正 |
| その他のError | プラグイン・プリセットのエラー | エラーメッセージに従って対処 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（ファイル変更時に自動で再コンパイル） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（コンパイル時に同期的に出力）

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

- ファイルパスやソースコードの一部が出力される可能性がある
- スタックトレースにローカルパスが含まれる
- 公開ログには注意が必要

## 備考

- ウォッチモードでは、エラー後も処理が継続され、ファイル修正後の再コンパイルが可能
- 通常モードでは、エラーによりプロセスが終了し、終了コード1が返される
- FILE_TYPE.ERR_COMPILATIONは成功カウントには含まれない

---

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

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

### 推奨読解順序

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

まず、FILE_TYPE列挙型を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | dir.ts | `packages/babel-cli/src/babel/dir.ts` | FILE_TYPE定義（9-14行目） |

**読解のコツ**: `ERR_COMPILATION`がエラー状態を表すことを確認する。

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

エラー出力を行うwrite関数の実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | dir.ts | `packages/babel-cli/src/babel/dir.ts` | write関数の実装（25-86行目） |

**主要処理フロー**:
1. **行44-48**: util.compileでファイルをコンパイル
2. **行78-85**: try-catchでエラーをキャッチ
3. **行79-81**: ウォッチモードの場合、console.errorでエラー出力
4. **行81**: FILE_TYPE.ERR_COMPILATION返却

#### Step 3: ファイル変更検知時のエラー処理を理解する

onFilesChangeコールバックでのエラー処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | dir.ts | `packages/babel-cli/src/babel/dir.ts` | onFilesChangeコールバック（234-250行目） |

**主要処理フロー**:
- **行238-243**: Promise.allでファイル処理
- **行244-246**: try-catchでエラーをキャッチし、console.errorで出力

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

```
babel --watch --out-dir
    │
    ├─ write(src, base)
    │      │
    │      ├─ util.compile(src, options)
    │      │      │
    │      │      └─ エラー発生
    │      │
    │      └─ catch (err)
    │             └─ console.error(err)  ← エラー出力
    │
    └─ watcher.onFilesChange(callback)
           │
           └─ handleFile(filename, base)
                  │
                  └─ catch (err)
                         └─ console.error(err)  ← エラー出力
```

### データフロー図

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

ソースファイル ───▶ write関数 ───▶ コンパイル結果/エラー
                              │
                              ▼ (エラー発生 + ウォッチモード)
                        console.error ───▶ stderr（エラー情報）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| dir.ts | `packages/babel-cli/src/babel/dir.ts` | ソース | ディレクトリコンパイル処理とエラー出力 |
| util.ts | `packages/babel-cli/src/babel/util.ts` | ソース | コンパイル処理のラッパー |
| watcher.ts | `packages/babel-cli/src/babel/watcher.ts` | ソース | ファイル監視機能 |
| options.ts | `packages/babel-cli/src/babel/options.ts` | ソース | CLIオプション解析 |
