# 通知設計書 14-invalid regex flags

## 概要

本ドキュメントは、CoffeeScriptコンパイラにおける「invalid regular expression flags」（無効な正規表現フラグエラー）通知の設計仕様を定義する。

### 本通知の処理概要

この通知は、CoffeeScriptソースコード内で正規表現リテラルに無効なフラグが指定された場合に発生する構文エラーを開発者に通知するものである。

**業務上の目的・背景**：JavaScriptの正規表現では、有効なフラグは `g`（グローバル）、`i`（大文字小文字無視）、`m`（複数行）、`s`（dotAll）、`u`（Unicode）、`y`（sticky）のみである。無効なフラグや重複するフラグを使用すると実行時エラーになるため、コンパイル時にこれを検出することで、開発者は早期に問題を発見できる。

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

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

**通知内容の概要**：エラーメッセージ「invalid regular expression flags {flags}」と、該当するソースコード内の位置情報（行番号・列番号）、および無効なフラグ文字列が含まれる。

**期待されるアクション**：開発者は該当する正規表現のフラグを確認し、有効なフラグ（g, i, m, s, u, y）のみを使用するよう修正する必要がある。重複フラグも削除する。

## 通知種別

コンパイルエラー（SyntaxError）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### エラーメッセージ

| 項目 | 内容 |
|-----|------|
| メッセージ形式 | `[ファイル名]:行:列: error: invalid regular expression flags {flags}` |
| 形式 | テキスト |

### 本文テンプレート

```
[stdin]:1:4: error: invalid regular expression flags ii
/a/ii
   ^^
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| flags | 無効なフラグ文字列 | REGEX_FLAGS.exec結果 | Yes |
| first_line | エラー発生行番号 | Lexer.getLineAndColumnFromChunk | Yes |
| first_column | エラー発生列番号 | Lexer.getLineAndColumnFromChunk | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | regexTokenメソッド実行 | `not VALID_FLAGS.test flags` | フラグがVALID_FLAGSにマッチしない |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 有効フラグ | フラグがVALID_FLAGS（/^(?!.*(.).*\1)[gimsuy]*$/）にマッチする場合はエラーなし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ソースコード読み込み] --> B[regexTokenメソッド呼び出し]
    B --> C[正規表現リテラル検出]
    C --> D[REGEX_FLAGSでフラグ抽出]
    D --> E{VALID_FLAGS.test flags}
    E -->|false| F[error 'invalid regular expression flags' 呼び出し]
    E -->|true| G[通常処理継続]
    F --> H[throwSyntaxError]
    H --> I[コンパイル停止]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| SyntaxError | 無効なフラグ（例: /a/ii, /a/G） | 有効なフラグのみ使用する |
| SyntaxError | 重複フラグ（例: /a/gimi） | 重複を削除する |
| SyntaxError | 無効な文字（例: /a/g_） | 無効な文字を削除する |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

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

## 備考

- 有効なフラグは `g`, `i`, `m`, `s`, `u`, `y` の6種類
- `VALID_FLAGS`正規表現: `/^(?!.*(.).*\1)[gimsuy]*$/`（否定先読みで重複フラグを検出）
- ヒアドキュメント形式の正規表現（`///`）にも同様のチェックが適用される

---

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

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

### 推奨読解順序

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

正規表現関連の定数を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lexer.coffee | `src/lexer.coffee` | REGEX_FLAGS、VALID_FLAGS定数の定義を確認 |

**読解のコツ**: `VALID_FLAGS = /^(?!.*(.).*\1)[gimsuy]*$/`は否定先読み`(?!.*(.).*\1)`を使用して重複フラグを検出している。

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

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

**主要処理フロー**:
1. **444行目**: `regexToken`メソッド開始
2. **460行目**: `REGEX.exec @chunk`で正規表現リテラルをマッチ
3. **474行目**: `REGEX_FLAGS.exec @chunk[index..]`でフラグを抽出

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | lexer.coffee | `src/lexer.coffee` (477-479行) | フラグの検証とエラー発生 |

**主要処理フロー**:
- **474行目**: `[flags] = REGEX_FLAGS.exec @chunk[index..]`でフラグを取得
- **477行目**: `switch`文でフラグ検証を開始
- **478-479行目**: `when not VALID_FLAGS.test flags`の条件で`'invalid regular expression flags'`エラー

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

```
CoffeeScript.compile(source)
    │
    └─ Lexer.tokenize(code)
           │
           ├─ regexToken()
           │      ├─ REGEX.exec()でリテラル検出
           │      ├─ REGEX_FLAGS.exec()でフラグ抽出
           │      └─ VALID_FLAGS.test()でフラグ検証
           │             └─ error('invalid regular expression flags')
           │                    └─ throwSyntaxError()
           │
           └─ 他のトークン処理メソッド
```

### データフロー図

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

/pattern/flags ───▶ Lexer.regexToken() ───▶ SyntaxError例外
     │                    │
     │              REGEX_FLAGS.exec()
     │                    ↓
     │              flags抽出
     │                    ↓
     └─ flags ────▶ VALID_FLAGS.test(flags) → false
```

### 関連ファイル一覧

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