# バッチ設計書 47-gulp bundle-dts

## 概要

本ドキュメントは、Babelプロジェクトにおける型定義ファイルバンドルバッチ `gulp bundle-dts` の設計について記載する。このバッチはTypeScript型定義ファイル（.d.ts）をrollup-plugin-dtsを使用してバンドルする。

### 本バッチの処理概要

**業務上の目的・背景**：Babelパッケージの型定義ファイルを単一のファイルにバンドルするためのバッチである。TypeScriptユーザーがBabelパッケージを使用する際に、適切な型情報を得られるようにする。型定義のバンドルにより、ユーザーの開発体験が向上し、IDEでの補完やエラーチェックが正確になる。

**バッチの実行タイミング**：`gulp build-dev` の一部として実行される（bundle-babel-parser-dts）。また、prepublish時にフルの型定義バンドル（bundle-dts）が実行される。

**主要な処理内容**：
1. bundle-babel-parser-dts: babel-parserの型定義をバンドル
   - babel-parser.source.d.tsを入力としてbabel-parser.d.tsを生成
   - エラー情報のパッチ適用
2. bundle-babel-packages-dts: 各パッケージの型定義をバンドル
   - dts/packages/*/src/index.d.tsを入力として各パッケージのlib/index.d.tsを生成
   - CLIパッケージ、ランタイムパッケージ等は除外

**前後の処理との関連**：TypeScriptコンパイル（make tscheck / tsc）で生成された.d.tsファイルが入力となる。バンドル後の型定義はnpmパッケージ公開時に同梱される。

**影響範囲**：packages/babel-parser/typings/babel-parser.d.tsおよび各パッケージのlib/index.d.tsが生成・更新される。

## バッチ種別

ビルド処理（型定義バンドル）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | gulp build-dev時（パーサーのみ）、prepublish時（全パッケージ） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | gulp bundle-dts / gulp bundle-babel-parser-dts |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | Node.js 20以上が必要 |
| 依存関係インストール済み | `yarn install` によりnode_modulesが構築済み |
| TypeScriptコンパイル済み | dts/ディレクトリに.d.tsファイルが生成済み |
| rollup-plugin-dts | 型定義バンドル用プラグインがインストール済み |

### 実行可否判定

入力となる.d.tsファイルが存在すればバンドル可能。dts/ディレクトリはTypeScriptコンパイル時に生成される。

## 入力仕様

### 入力パラメータ

本バッチは環境変数による設定は行わない。

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| packages/babel-parser/typings/babel-parser.source.d.ts | TypeScript定義 | パーサーの元型定義 |
| dts/packages/*/src/index.d.ts | TypeScript定義 | 各パッケージの型定義 |
| packages/*/package.json | JSON | 依存関係の参照（外部依存の除外用） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| packages/babel-parser/typings/babel-parser.d.ts | TypeScript定義 | バンドルされたパーサー型定義 |
| packages/*/lib/index.d.ts | TypeScript定義 | 各パッケージのバンドル型定義 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | babel-parser.d.ts / index.d.ts |
| 出力先 | typings/ または lib/ |
| 文字コード | UTF-8 |
| バナーコメント | 自動生成警告（パーサーのみ） |

## 処理フロー

### 処理シーケンス

```
1. bundle-babel-parser-dts
   ├─ babel-parser.source.d.tsを入力
   ├─ BABEL_8_BREAKING型定義を置換
   ├─ rollup-plugin-dtsでバンドル
   ├─ エラー情報パッチ適用（patchErrorInfo）
   ├─ 再度バンドル（パッチ適用後）
   └─ Prettierでフォーマット

2. bundle-babel-packages-dts（並列）
   ├─ 対象パッケージを列挙（CLI等は除外）
   └─ 各パッケージについて:
       ├─ dts/packages/*/src/index.d.tsを入力
       ├─ package.jsonから外部依存を抽出
       ├─ rollup-plugin-dtsでバンドル
       └─ lib/index.d.tsに出力
```

### フローチャート

```mermaid
flowchart TD
    A[gulp bundle-dts] --> B{gulp.parallel}
    B --> C[bundle-babel-parser-dts]
    B --> D[bundle-babel-packages-dts]
    C --> E[babel-parser.source.d.ts読込]
    E --> F[BABEL_8_BREAKING置換]
    F --> G[rollup-plugin-dtsバンドル]
    G --> H[patchErrorInfo適用]
    H --> I[再バンドル]
    I --> J[Prettier整形]
    J --> K[babel-parser.d.ts出力]
    D --> L[対象パッケージ列挙]
    L --> M[各パッケージ並列処理]
    M --> N[rollup-plugin-dtsバンドル]
    N --> O[lib/index.d.ts出力]
    K --> P[バッチ終了]
    O --> P
```

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

### 操作別データベース影響一覧

本バッチはデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| UNRESOLVED_IMPORT | 警告 | vmモジュール未解決時 | 無視（@types/node不足） |
| UNUSED_EXTERNAL_IMPORT | 警告 | 未使用のdefaultインポート | 無視（rollup-plugin-dtsの仕様） |
| - | バンドルエラー | 型定義の構文エラー | ソースの型定義を修正 |

### リトライ仕様

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

### 障害時対応

バンドルエラー時は、元の.d.tsファイルの構文を確認する。TypeScriptコンパイルが正常に完了していることを確認し、必要に応じてmake tscheckを実行する。

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

本バッチはデータベーストランザクションを使用しない。

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 約100パッケージ |
| 目標処理時間 | 1〜3分 |
| メモリ使用量上限 | 1GB〜2GB |

## 排他制御

bundle-babel-packages-dtsはPromise.allで各パッケージを並列処理する。各パッケージは独立したファイルに出力するため、競合は発生しない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バンドル開始時 | Bundling 'xxx' with rollup ... |
| 警告ログ | 警告発生時 | Rollup警告メッセージ |
| エラーログ | エラー発生時 | エラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ビルド失敗 | 1回 | CI/CDシステム通知 |

## 備考

- 除外パッケージ一覧（dtsBundles定義外）:
  - packages/babel-cli（CLI）
  - packages/babel-build-external-helpers（CLI）
  - packages/babel-node（CLI）
  - packages/babel-compat-data（JSONのみ）
  - packages/babel-helper-globals（JSONのみ）
  - packages/babel-runtime（ユーザー直接消費想定外）
  - packages/babel-runtime-corejs3（ユーザー直接消費想定外）
  - packages/babel-register（TODO: 型定義追加予定）
- patchErrorInfoはbabel-parserのエラー情報を型定義に挿入する
- BABEL_8_BREAKING型はtrueに固定される（Babel 8向け型定義）
- package.jsonのimportsフィールドに対応したカスタムresolveIdがある
