# 通知設計書 33-構文エラー

## 概要

本ドキュメントは、`@babel/parser`が構文エラーを検出した場合のSyntaxError通知に関する設計を記載する。

### 本通知の処理概要

構文エラー通知は、Babelパーサーがソースコードを解析中に文法的に不正な構文を検出した場合、開発者に詳細なエラー情報を提供するメカニズムである。

**業務上の目的・背景**：JavaScriptやTypeScriptのソースコードをAST（抽象構文木）に変換する過程で、文法規則に違反するコードを検出することは不可欠である。構文エラーは、不正なコードがランタイムに到達する前に問題を特定し、開発者が素早く修正できるようにする。エラーメッセージには位置情報（行番号、列番号）が含まれ、IDEやエディタでのエラー表示にも活用される。

**通知の送信タイミング**：パーサーがソースコードをトークン化・解析する過程で、文法規則に違反する構文を検出した時点で即座にSyntaxErrorがスローされる。

**通知の受信者**：Babelを呼び出しているコード（CLI、ビルドツール、IDE等）。try-catchでエラーをキャッチして処理する。

**通知内容の概要**：エラーメッセージ、エラーコード（BABEL_PARSER_SYNTAX_ERROR等）、理由コード（reasonCode）、位置情報（行・列・インデックス）、必要なプラグイン情報（missingPlugin）等が含まれる。

**期待されるアクション**：開発者はエラーメッセージと位置情報を参照してソースコードを修正する。必要に応じてパーサープラグインを追加する。

## 通知種別

パースエラー（SyntaxError例外）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（例外スロー） |
| 優先度 | 高（処理を中断） |
| リトライ | 無し |

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

呼び出し元のコードに対して例外をスローする。送信先の動的決定は行われない。

## 通知テンプレート

### SyntaxError例外の場合

| 項目 | 内容 |
|-----|------|
| エラー型 | SyntaxError |
| 拡張プロパティ | code, reasonCode, loc, pos, syntaxPlugin, missingPlugin, details |

### エラーメッセージテンプレート

```
{エラーメッセージ} ({行番号}:{列番号})
```

例:
```
Unexpected token, expected ";" (1:10)
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| message | エラーメッセージ | toMessage関数の戻り値 | Yes |
| code | エラーコード | ParseErrorCredentials.code | Yes |
| reasonCode | 理由コード | ParseErrorCredentials.reasonCode | Yes |
| loc | 位置情報（Position） | パーサー状態 | Yes |
| pos | インデックス位置 | loc.index | Yes |
| syntaxPlugin | 構文プラグイン名 | ParseErrorCredentials.syntaxPlugin | No |
| missingPlugin | 必要なプラグイン | details.missingPlugin | No |
| details | エラー詳細オブジェクト | エラーごとに異なる | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| パース処理 | 予期しないトークン | 文法規則違反 | 期待されるトークンと異なるトークンを検出 |
| パース処理 | 無効な識別子 | 識別子規則違反 | 識別子として無効な文字列を検出 |
| パース処理 | 無効な数値リテラル | 数値形式違反 | 不正な数値形式を検出 |
| パース処理 | 未終了の文字列 | 文字列リテラル不正 | 閉じられていない文字列を検出 |
| パース処理 | 未終了の正規表現 | 正規表現不正 | 閉じられていない正規表現を検出 |
| パース処理 | プラグイン未設定 | 実験的構文使用 | 必要なパーサープラグインが有効でない |
| パース処理 | モジュール構文エラー | sourceType不一致 | script modeでimport/exportを使用 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | 構文エラー検出時は必ずSyntaxErrorがスローされる |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[パース処理開始] --> B[トークン読み取り]
    B --> C{文法規則に適合?}
    C -->|Yes| D[AST構築継続]
    D --> B
    C -->|No| E[エラーコンストラクタ呼び出し]
    E --> F[SyntaxError生成]
    F --> G[code, reasonCode設定]
    G --> H[loc, pos設定]
    H --> I[message生成]
    I --> J[例外スロー]
    J --> K[呼び出し元でキャッチ]
```

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

該当なし

### 参照テーブル一覧

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

この機能自体がエラー通知であるため、追加のエラー処理は存在しない。

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（エラー検出時に即座にスロー）

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

- エラーメッセージにソースコードの一部が含まれる場合があるが、開発環境での使用を想定
- 位置情報（行番号、列番号）のみが公開され、コード全体は含まれない
- エラーメッセージは国際化されておらず、英語のみ

## 備考

- エラーの種類は複数のファイルに分散して定義されている：
  - StandardErrors: 標準的な構文エラー
  - ModuleErrors: モジュール関連エラー
  - StrictModeErrors: strictモード関連エラー
  - ParseExpressionErrors: 式パース関連エラー
  - PipelineOperatorErrors: パイプラインオペレーター関連エラー
- プラグイン固有のエラー（TypeScript、Flow、JSX等）は各プラグインで定義
- `clone`メソッドにより、エラーの位置や詳細を変更したコピーを作成可能

---

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

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

### 推奨読解順序

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

ParseError型とその構成要素を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | parse-error.ts | `packages/babel-parser/src/parse-error.ts` | ParseErrorSpecification、ParseError型の定義（21-46行目） |
| 1-2 | location.ts | `packages/babel-parser/src/util/location.ts` | Position型の定義 |

**読解のコツ**: ParseErrorはSyntaxErrorを拡張した型であり、code, reasonCode, loc, pos, details等の追加プロパティを持つ。ParseErrorConstructorはファクトリ関数として機能する。

#### Step 2: エラーコンストラクタの生成を理解する

ParseErrorEnumとtoParseErrorConstructorの仕組みを把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | parse-error.ts | `packages/babel-parser/src/parse-error.ts` | toParseErrorConstructor関数（75-125行目） |
| 2-2 | parse-error.ts | `packages/babel-parser/src/parse-error.ts` | ParseErrorEnum関数（190-227行目） |

**主要処理フロー**:
1. **84-90行目**: SyntaxErrorを生成、code/reasonCode/loc/posを設定
2. **92-95行目**: syntaxPlugin/missingPluginの設定
3. **101-107行目**: clone関数の定義（位置変更可能）
4. **111-121行目**: messageゲッターの定義（遅延評価）

#### Step 3: エラー定義を理解する

各種エラーテンプレートの定義を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | standard-errors.ts | `packages/babel-parser/src/parse-error/standard-errors.ts` | 標準エラーの定義（24-296行目） |
| 3-2 | module-errors.ts | `packages/babel-parser/src/parse-error/module-errors.ts` | モジュールエラーの定義 |
| 3-3 | strict-mode-errors.ts | `packages/babel-parser/src/parse-error/strict-mode-errors.ts` | strictモードエラー |

**主要処理フロー**:
- **静的メッセージ**: `UnterminatedComment: "Unterminated comment."`
- **動的メッセージ**: `UnexpectedToken: ({ expected, unexpected }) => ...`
- **コードオーバーライド**: `ImportOutsideModule: { message: ..., code: "BABEL_PARSER_SOURCETYPE_MODULE_REQUIRED" }`

#### Step 4: エラーの集約を理解する

Errorsオブジェクトへの集約を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | parse-error.ts | `packages/babel-parser/src/parse-error.ts` | Errorsオブジェクトの構築（239-245行目） |

**主要処理フロー**:
- **239-245行目**: 各種エラーテンプレートをParseErrorEnumで変換し、Errorsオブジェクトに集約

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

```
パーサー (parser/*.ts)
    │
    ├─ Errors.{ErrorName}(loc, details)
    │      │
    │      └─ ParseErrorConstructor
    │             │
    │             └─ toParseErrorConstructor
    │                    │
    │                    ├─ new SyntaxError()
    │                    ├─ error.code = code
    │                    ├─ error.reasonCode = reasonCode
    │                    ├─ error.loc = loc
    │                    ├─ error.pos = loc.index
    │                    └─ error.message = toMessage(details)
    │
    └─ throw error
           │
           └─ 呼び出し元でcatch
```

### データフロー図

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

ソースコード ───▶ Tokenizer ───▶ Parser
                                    │
                              文法チェック
                                    │
                            ┌───────┴───────┐
                            ▼               ▼
                         適合            違反
                            │               │
                            ▼               ▼
                        AST構築     Errors.{name}()
                                          │
                                          ▼
                                   SyntaxError生成
                                          │
                                          ▼
                                     throw error
                                          │
                                          ▼
                                   呼び出し元
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| parse-error.ts | `packages/babel-parser/src/parse-error.ts` | ソース | ParseError型定義、エラーコンストラクタ生成 |
| standard-errors.ts | `packages/babel-parser/src/parse-error/standard-errors.ts` | ソース | 標準構文エラーテンプレート |
| module-errors.ts | `packages/babel-parser/src/parse-error/module-errors.ts` | ソース | モジュール関連エラーテンプレート |
| strict-mode-errors.ts | `packages/babel-parser/src/parse-error/strict-mode-errors.ts` | ソース | strictモードエラーテンプレート |
| parse-expression-errors.ts | `packages/babel-parser/src/parse-error/parse-expression-errors.ts` | ソース | 式パースエラーテンプレート |
| pipeline-operator-errors.ts | `packages/babel-parser/src/parse-error/pipeline-operator-errors.ts` | ソース | パイプラインオペレーターエラー |
| location.ts | `packages/babel-parser/src/util/location.ts` | ソース | Position型定義 |
| to-node-description.ts | `packages/babel-parser/src/parse-error/to-node-description.ts` | ソース | ノード説明文生成 |
