# バッチ設計書 12-generate-flow-estree-type-definition

## 概要

本ドキュメントは、Prettierプロジェクトにおける `generate-flow-estree-type-definition.js` バッチの設計仕様を定義します。このバッチは、hermes-estreeパッケージのFlow型定義ファイルからTypeScript型定義ファイルを自動生成するスクリプトです。

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

このバッチは、Flow言語の型定義をTypeScript形式に変換し、PrettierのJavaScriptパーサーで使用する型定義を自動生成します。hermes-estreeパッケージに含まれるFlow形式の型定義ファイルを読み込み、構文変換を行った後、TypeScript型定義ファイルとして出力します。

**業務上の目的・背景**：PrettierはFlow言語をサポートするパーサーを持っていますが、プロジェクト全体ではTypeScriptを使用しています。hermes-estreeが提供するFlow型定義を手動でTypeScriptに変換・維持することは労力がかかるため、自動変換スクリプトにより一貫性と保守性を確保します。これにより、上流のhermes-estreeの更新に追従しやすくなります。

**バッチの実行タイミング**：hermes-estreeパッケージの更新時、または型定義の更新が必要な時に手動で実行します。

**主要な処理内容**：
1. hermes-estreeパッケージのFlow型定義ファイル（types.js.flow）を読み込む
2. Flow固有の構文をTypeScript形式に変換（$ReadOnlyArray→ReadonlyArray等）
3. Prettierを使用してフォーマットを整える
4. TypeScriptコンパイラで生成ファイルの妥当性を検証
5. エラーがなければ型定義ファイルを出力、エラーがあれば詳細を表示して失敗

**前後の処理との関連**：このバッチは単独で実行されますが、生成されたファイルはビルドプロセスやテストで参照されます。ensure-no-files-changed.jsで変更の有無を検証されることがあります。

**影響範囲**：`src/language-js/types/flow-estree.d.ts`ファイルが更新されます。このファイルはPrettierのFlow言語サポートに関わる型定義を提供します。

## バッチ種別

コード生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（依存パッケージ更新時） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | Node.js実行環境が利用可能であること |
| hermes-estree | node_modules/hermes-estree がインストール済みであること |
| 依存パッケージ | @babel/code-frame, typescript, prettier がインストール済みであること |

### 実行可否判定

hermes-estreeパッケージがnode_modulesに存在する場合に実行可能です。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | コマンドライン引数は受け取りません |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| node_modules/hermes-estree/dist/types.js.flow | Flow型定義 | hermes-estreeのFlow型定義ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| src/language-js/types/flow-estree.d.ts | TypeScript型定義 | 変換されたTypeScript型定義ファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | flow-estree.d.ts |
| 出力先 | src/language-js/types/ |
| 文字コード | UTF-8 |
| 形式 | TypeScript Declaration File |

## 処理フロー

### 処理シーケンス

```
1. Flow型定義ファイルの読み込み
   └─ hermes-estree/dist/types.js.flowを読み込む

2. 型定義の変換（toDts関数）
   └─ 'use strict' ディレクティブの削除
   └─ {+foo: string} → {foo: string} への変換
   └─ interface {} → {} への変換
   └─ interface extends T {} → T & {} への変換
   └─ $ReadOnlyArray<?T> → ReadonlyArray<T | null> への変換
   └─ $ReadOnlyArray<T> → ReadonlyArray<T> への変換
   └─ $ReadOnly<T> → Readonly<T> への変換
   └─ [string]: T → [key: string]: T への変換

3. ヘッダーコメントの追加
   └─ 生成元ファイル情報と更新コマンドを記載

4. Prettierによるフォーマット
   └─ TypeScriptパーサーでフォーマット

5. ファイル出力
   └─ flow-estree.d.tsに書き込み

6. TypeScriptコンパイラによる検証
   └─ 型定義の妥当性をチェック
   └─ エラーがあればファイルを削除してエラーを報告
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[Flow型定義ファイル読み込み]
    B --> C[toDts関数で構文変換]
    C --> D[ヘッダーコメント追加]
    D --> E[Prettierでフォーマット]
    E --> F[ファイル出力]
    F --> G[TypeScriptコンパイラで検証]
    G --> H{診断エラーあり?}
    H -->|なし| I[正常終了]
    H -->|あり| J[ファイル削除]
    J --> K[エラー詳細表示]
    K --> L[エラー終了]
```

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

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

データベース操作はありません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | TypeScript診断エラー | 生成した型定義にTypeScriptエラーがある | 変換ロジック（toDts関数）を修正 |
| - | ファイル読み込みエラー | hermes-estreeファイルが見つからない | yarn installを実行 |

### リトライ仕様

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

### 障害時対応

1. TypeScript診断エラーの場合：
   - @babel/code-frameを使用してエラー箇所が表示される
   - エラーメッセージとコード位置を確認し、toDts関数の変換ルールを修正
   - 生成ファイルは自動削除される

2. ファイル読み込みエラーの場合：
   - `yarn install`を実行してhermes-estreeをインストール

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A |
| コミットタイミング | N/A |
| ロールバック条件 | TypeScript検証エラー時に出力ファイルを削除 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1ファイル |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | 制限なし |

## 排他制御

同時実行の制限はありません。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| エラーログ | TypeScript検証失敗時 | エラーメッセージとcode frame |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 実行エラー | 発生時 | CIパイプラインの失敗通知 |

## 備考

- 生成ファイルには自動生成の警告コメントとspell-checker無効化ディレクティブが含まれます
- 変換ロジックはFlow固有の構文パターンに対応しており、hermes-estreeの更新で新しいパターンが追加された場合はtoDts関数の修正が必要になる可能性があります
- ES Modules形式で実装されています
