# 通知設計書 15-missing regex closer

## 概要

本ドキュメントは、CoffeeScriptコンパイラにおける「missing / (unclosed regex)」（正規表現未閉鎖エラー）通知の設計仕様を定義する。

### 本通知の処理概要

この通知は、CoffeeScriptソースコード内で正規表現リテラルが閉じられていない場合に発生する構文エラーを開発者に通知するものである。

**業務上の目的・背景**：正規表現リテラルは開始スラッシュ（`/`）と終了スラッシュで囲まれる必要がある。終了スラッシュがない場合、コンパイラは正規表現の終端を特定できず、後続のコードを誤って正規表現の一部として解釈する可能性がある。この通知により、開発者は正規表現の記述ミスを早期に発見できる。

**通知の送信タイミング**：字句解析（Lexer）フェーズにおいて、`regexToken`メソッドが正規表現リテラルを処理する際に発生する。REGEX正規表現でマッチを試み、`closed`（閉じフラグ）がfalseの場合に検出される。

**通知の受信者**：CoffeeScriptコードをコンパイルしている開発者。コマンドラインツール、REPL、またはプログラムからの呼び出し時に、標準エラー出力またはエラーオブジェクトとして通知される。

**通知内容の概要**：エラーメッセージ「missing / (unclosed regex)」と、該当するソースコード内の位置情報（行番号・列番号）が含まれる。

**期待されるアクション**：開発者は該当する正規表現リテラルに終了スラッシュを追加するか、エスケープが必要なスラッシュを適切にエスケープする必要がある。

## 通知種別

コンパイルエラー（SyntaxError）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル時即時） |
| 優先度 | 高（コンパイル停止） |
| リトライ | なし |

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

コンパイラ呼び出し元に対してエラーがスローされる。CLIの場合は標準エラー出力、プログラムAPIの場合は例外としてスローされる。

## 通知テンプレート

### エラーメッセージ

| 項目 | 内容 |
|-----|------|
| メッセージ形式 | `[ファイル名]:行:列: error: missing / (unclosed regex)` |
| 形式 | テキスト |

### 本文テンプレート

```
[stdin]:1:1: error: missing / (unclosed regex)
/
^
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| first_line | エラー発生行番号 | Lexer.getLineAndColumnFromChunk | Yes |
| first_column | エラー発生列番号 | Lexer.getLineAndColumnFromChunk | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | regexTokenメソッド実行 | `closed`がfalse | 正規表現の終了スラッシュが見つからない |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 正常終了 | 正規表現が正しく閉じられている場合はエラーなし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ソースコード読み込み] --> B[regexTokenメソッド呼び出し]
    B --> C[REGEX.execで正規表現リテラル検出]
    C --> D[regex, body, closed を取得]
    D --> E{closed == true?}
    E -->|No| F[error 'missing / (unclosed regex)' 呼び出し]
    E -->|Yes| G[通常処理継続]
    F --> H[throwSyntaxError]
    H --> I[コンパイル停止]
```

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

### 参照テーブル一覧

該当なし（ファイルベースの処理）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| SyntaxError | 終了スラッシュがない（例: `/pattern`） | 終了スラッシュを追加 |
| SyntaxError | エスケープされたスラッシュのみ（例: `/a\/`） | 正しいエスケープと終了スラッシュを確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

該当なし（即時エラー通知）

### 配信時間帯

制限なし

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

特になし。ソースコードの内容がエラーメッセージに含まれる可能性があるが、開発時のみ表示されるため問題なし。

## 備考

- REGEX定数で正規表現リテラルのパターンを定義
- `closed`はREGEXマッチ結果の3番目の要素で、終了スラッシュの存在を示す
- 文字クラス内のスラッシュ（例: `/[/]/`）は正しく処理される必要があるが、ネストした場合に問題が発生することがある

---

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

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

### 推奨読解順序

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

正規表現関連の定数とマッチ結果の構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lexer.coffee | `src/lexer.coffee` | REGEX定数の定義（正規表現リテラルのパターン）を確認 |

**読解のコツ**: REGEXマッチ結果は`[regex, body, closed]`の構造を持つ。`closed`は終了スラッシュの存在を示すブール値相当。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | lexer.coffee | `src/lexer.coffee` | regexTokenメソッド（444行目〜）がエントリーポイント |

**主要処理フロー**:
1. **444行目**: `regexToken`メソッド開始
2. **460行目**: `REGEX.exec @chunk`で正規表現リテラルをマッチ
3. **461行目**: `[regex, body, closed] = match`でマッチ結果を分解

#### Step 3: 実際のエラー検出ロジック

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | lexer.coffee | `src/lexer.coffee` (470行) | closedフラグのチェックとエラー発生 |

**主要処理フロー**:
- **460行目**: `when match = REGEX.exec @chunk`で正規表現にマッチ
- **461行目**: `[regex, body, closed] = match`で分解
- **470行目**: `@error 'missing / (unclosed regex)' unless closed`でclosedがfalseならエラー

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

```
CoffeeScript.compile(source)
    │
    └─ Lexer.tokenize(code)
           │
           ├─ regexToken()
           │      ├─ REGEX.exec()でリテラル検出
           │      ├─ [regex, body, closed] = match
           │      └─ unless closed チェック
           │             └─ error('missing / (unclosed regex)')
           │                    └─ throwSyntaxError()
           │
           └─ 他のトークン処理メソッド
```

### データフロー図

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

/pattern ────────▶ Lexer.regexToken() ───▶ SyntaxError例外
     │                    │
     │              REGEX.exec()
     │                    ↓
     │              [regex, body, closed] 分解
     │                    ↓
     └────────────▶ closed == false → エラー
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lexer.coffee | `src/lexer.coffee` | ソース | 字句解析器本体、regexTokenメソッド（444-502行目） |
| lexer.coffee | `src/lexer.coffee` | ソース | REGEX定数定義 |
| helpers.coffee | `src/helpers.coffee` | ソース | throwSyntaxError関数の定義 |
| error_messages.coffee | `test/error_messages.coffee` | テスト | unclosed regexesのテストケース（669-693行目） |
