# 機能設計書 53-@babel/plugin-transform-dotall-regex

## 概要

本ドキュメントは、Babelプラグイン `@babel/plugin-transform-dotall-regex` の機能設計を記載したものである。本プラグインは、ES2018で導入された正規表現の `s`（dotAll）フラグを使用した正規表現をES5互換の正規表現に変換する。

### 本機能の処理概要

**業務上の目的・背景**：従来の正規表現では、メタ文字 `.`（ドット）は改行文字（`\n`、`\r`、行区切り文字、段落区切り文字）にはマッチしなかった。ES2018で導入された `s`（dotAll）フラグを使用すると、`.` が改行文字を含むすべての文字にマッチするようになる。しかし、古いJavaScript実行環境ではこの `s` フラグがサポートされていないため、トランスパイルが必要となる。本プラグインは、`s` フラグを使用した正規表現を、同等の動作を持つES5互換の正規表現に変換する。

**機能の利用シーン**：
- 複数行にまたがるテキストを単一のパターンでマッチングする場合
- HTMLやXMLなどのマークアップ言語で、改行を含むタグ内容を抽出する場合
- ログファイルなど、改行を含む可能性のあるデータを正規表現で処理する場合

**主要な処理内容**：
1. AST内のRegExpLiteralノードを検出
2. `s`（dotAll）フラグを持つ正規表現を識別
3. `regexpu-core` ライブラリを使用してパターンを変換（`.` を `[\s\S]` 等に置換）
4. `s` フラグを除去

**関連システム・外部連携**：`@babel/helper-create-regexp-features-plugin` を使用して正規表現機能変換の共通処理を実行。内部的に `regexpu-core` ライブラリを利用してパターン変換を行う。

**権限による制御**：本プラグインに権限制御の概念は存在しない。

## 関連画面

該当なし（CLIツール/ビルドツールとして動作）

## 機能種別

データ変換処理（ASTトランスフォーム）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| - | - | - | 本プラグインにはユーザー設定可能なオプションはない | - |

### 入力データソース

- Babelコアから渡されるAST（抽象構文木）
- `RegExpLiteral` ノードが処理対象

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 変換後AST | AST Node | sフラグが除去され、パターンが変換された正規表現リテラル |

### 出力先

変換されたASTはBabelコアに返され、最終的にJavaScriptコードとして出力される

## 処理フロー

### 処理シーケンス

```
1. プラグイン初期化
   └─ Babelバージョン検証（^7.0.0-0 || ^8.0.0）

2. createRegExpFeaturePlugin 呼び出し
   └─ プラグイン名: "transform-dotall-regex"
   └─ 機能フラグ: "dotAllFlag"

3. pre フック実行（ファイル処理開始時）
   └─ featuresKey に機能フラグを設定

4. RegExpLiteral ノード訪問
   └─ 正規表現の特徴を分析
   └─ sフラグの有無を判定
   └─ regexpu-core でパターン変換（. → [\s\S] 等）
   └─ sフラグを除去（transformFlags）
```

### フローチャート

```mermaid
flowchart TD
    A[RegExpLiteral検出] --> B{sフラグあり?}
    B -->|No| Z[スキップ]
    B -->|Yes| C[regexpu-coreで変換]
    C --> D[.を[\s\S]に置換]
    D --> E[sフラグを除去]
    E --> F[変換完了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | dotAll変換 | `.` を改行にもマッチする文字クラスに変換 | sフラグ付き正規表現 |
| BR-02 | sフラグ除去 | 変換後はsフラグを除去 | sフラグ付き正規表現 |

### 計算ロジック

dotAllフラグの変換は `regexpu-core` ライブラリが担当。`.` を `[\s\S]` または `[^]` に展開することで、改行を含むすべての文字にマッチさせる。

## データベース操作仕様

該当なし（データベース操作は行わない）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | SyntaxError | 不正な正規表現パターン | Babelコアがエラー報告 |

### リトライ仕様

該当なし

## トランザクション仕様

該当なし（ステートレスな変換処理）

## パフォーマンス要件

- 変換処理は非常に軽量
- `canSkipRegexpu` による早期スキップで不要な変換を回避

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

- 特になし（変換は純粋なパターン置換）

## 備考

- ES2018以降をネイティブサポートする環境ではこのプラグインは不要
- `@babel/preset-env` 使用時は、ターゲット環境に応じて自動的に適用される
- `.` を `[\s\S]` に変換する手法は、従来からdotAllの代替手段として広く使われていた

---

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

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

### 推奨読解順序

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

正規表現機能プラグインで使用される機能フラグの定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | features.ts | `packages/babel-helper-create-regexp-features-plugin/src/features.ts` | FEATURESオブジェクトで定義される機能フラグ（dotAllFlag = 1 << 1）を確認 |

**読解のコツ**: dotAllFlagは2番目のビット（1 << 1 = 2）として定義されている。

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

プラグインの初期化処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | index.ts | `packages/babel-plugin-transform-dotall-regex/src/index.ts` | プラグイン定義（非常にシンプル、オプションなし） |

**主要処理フロー**:
1. **5-6行目**: Babelバージョン検証
2. **8-11行目**: `createRegExpFeaturePlugin` の呼び出し、"dotAllFlag" 機能の指定

#### Step 3: ヘルパープラグインのコア処理を理解する

正規表現変換の共通ロジックを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | util.ts | `packages/babel-helper-create-regexp-features-plugin/src/util.ts` | sフラグの判定と除去ロジック |
| 3-2 | index.ts | `packages/babel-helper-create-regexp-features-plugin/src/index.ts` | 共通のプラグイン構造とVisitor実装 |

**主要処理フロー**:
- **37行目（util.ts）**: `dotAllFlag: feat("dotAllFlag")` でオプション生成
- **65-67行目（util.ts）**: sフラグの有無チェック（canSkipRegexpu内）
- **87-89行目（util.ts）**: sフラグ除去（transformFlags内）

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

```
@babel/plugin-transform-dotall-regex
    │
    └─ createRegExpFeaturePlugin (helper)
           │
           ├─ pre(): dotAllFlag 設定
           │
           └─ visitor.RegExpLiteral()
                  │
                  ├─ generateRegexpuOptions()
                  │      └─ dotAllFlag: "transform"
                  │
                  ├─ canSkipRegexpu(): sフラグチェック
                  │
                  ├─ rewritePattern() [regexpu-core]
                  │      └─ . → [\s\S] 変換
                  │
                  └─ transformFlags()
                         └─ s フラグ除去
```

### データフロー図

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

ソースコード           @babel/parser                     変換後コード
/foo.bar/s      ───▶  RegExpLiteral AST  ───▶  Visitor  ───▶  /foo[\s\S]bar/
                                                  │
                                            regexpu-core
                                         (パターン変換)
                                            transformFlags
                                         (s フラグ除去)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| index.ts | `packages/babel-plugin-transform-dotall-regex/src/index.ts` | ソース | プラグインエントリーポイント |
| package.json | `packages/babel-plugin-transform-dotall-regex/package.json` | 設定 | パッケージ定義、依存関係 |
| index.ts | `packages/babel-helper-create-regexp-features-plugin/src/index.ts` | ソース | 正規表現機能プラグイン共通処理 |
| features.ts | `packages/babel-helper-create-regexp-features-plugin/src/features.ts` | ソース | 機能フラグ定義 |
| util.ts | `packages/babel-helper-create-regexp-features-plugin/src/util.ts` | ソース | ユーティリティ関数、フラグ変換 |
