# 通知設計書 26-変換エラー出力

## 概要

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

### 本通知の処理概要

この通知は、Babel CLIの`--out-file`オプションを使用してファイルを変換・結合する際、または複数ファイルを監視している際に、個別のファイル変換でエラーが発生した場合に、エラー情報を標準エラー出力に出力する機能を提供する。

**業務上の目的・背景**：ファイル結合モード（--out-file）では、複数のソースファイルを1つの出力ファイルにまとめる。ウォッチモードでは、変換エラーが発生しても監視を継続し、ユーザーがファイルを修正して再保存できるようにする。この機能により、エラー情報を即座にユーザーに通知しつつ、ウォッチモードの継続を可能にする。

**通知の送信タイミング**：`walk`関数内のファイル変換処理でエラーがキャッチされた際（ウォッチモードの場合）、または`files`関数内のwalkコール時にエラーがキャッチされた際に、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 |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ファイル変換中 | walk関数でのutil.compile呼び出し | ウォッチモードかつエラー発生 | 個別ファイルの変換時（201行目） |
| ウォッチ再変換 | onFilesChangeコールバック内のwalk呼び出し | エラー発生 | ファイル変更検知後の再変換時（237行目） |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[walk関数呼び出し] --> B[Promise.allでファイル変換]
    B --> C[各ファイルでutil.compile実行]
    C --> D{変換成功?}
    D -->|Yes| E[結果を返す]
    D -->|No| F{cliOptions.watch?}
    F -->|Yes| G[console.errorでエラー出力]
    G --> H[nullを返す]
    F -->|No| I[エラーをthrow]
    E --> J[output関数で出力]
    H --> J
    I --> K[プロセス終了]
    J --> L[処理完了]
```

### onFilesChange時のエラー処理フロー

```mermaid
flowchart TD
    A[ファイル変更検知] --> B[walk関数呼び出し]
    B --> C{変換成功?}
    C -->|Yes| D[処理完了]
    C -->|No| E[console.errorでエラー出力]
    E --> D
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（変換時に同期的に出力）

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

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

## 備考

- walk関数はPromise.allを使用して複数ファイルを並列処理する
- ウォッチモードでエラーが発生した場合、そのファイルはnullとして扱われる
- output関数はnull結果をスキップして処理を継続する

---

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

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

### 推奨読解順序

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

まず、CompilationOutput型を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | file.ts | `packages/babel-cli/src/babel/file.ts` | CompilationOutput型定義（19-23行目） |

**読解のコツ**: `code`と`map`の関係を理解する。

#### Step 2: walk関数のエラー処理を理解する

walk関数内でのエラーハンドリングを確認する。

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

**主要処理フロー**:
1. **行173-205**: Promise.allでファイルを並列処理
2. **行184-195**: util.compileでファイル変換
3. **行196-203**: try-catchでエラーをキャッチ
4. **行197-199**: ウォッチモードの場合はthrowせずにconsole.errorで出力
5. **行201**: console.errorでエラー出力してnullを返す

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | file.ts | `packages/babel-cli/src/babel/file.ts` | files関数のonFilesChangeコールバック（224-240行目） |

**主要処理フロー**:
- **行236-238**: walk呼び出し後のcatchでconsole.errorを実行

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

```
babel --watch --out-file
    │
    └─ files(filenames)
           │
           ├─ walk(filenames)
           │      │
           │      └─ Promise.all(...)
           │             │
           │             └─ util.compile(filename, options)
           │                    │
           │                    └─ エラー発生
           │                           │
           │                           └─ console.error(err)  ← エラー出力
           │
           └─ watcher.onFilesChange(callback)
                  │
                  └─ walk(filenames).catch(...)
                         │
                         └─ console.error(err)  ← エラー出力
```

### データフロー図

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

ソースファイル群 ───▶ walk関数 ───▶ 結合結果 or null
                              │
                              ▼ (エラー発生 + ウォッチモード)
                        console.error ───▶ stderr（エラー情報）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| file.ts | `packages/babel-cli/src/babel/file.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オプション解析 |
