# バッチ設計書 2-generate-builtin-plugins.js

## 概要

本ドキュメントは、Prettierのビルトインプラグイン定義ファイルを自動生成するスクリプト `scripts/generate-builtin-plugins.js` の設計仕様を記載したものです。

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

本バッチは、Prettierの言語プラグイン（JavaScript、TypeScript、HTML、CSS等）の定義を解析し、開発用（development）と本番用（production）の2種類のプラグイン定義ファイルを自動生成します。

**業務上の目的・背景**：Prettierは多数の言語プラグインをサポートしており、各プラグインのパーサー、プリンター、言語定義、オプションを一元管理する必要があります。手動でプラグイン定義を管理するとエラーや不整合が発生しやすいため、ソースコードから自動的に定義を抽出・生成することで、メンテナンス性と正確性を向上させます。

**バッチの実行タイミング**：プラグインの追加・変更時、ビルドプロセス前の準備段階で実行されます。開発者が手動で実行するか、CI/CDパイプラインで自動実行されます。

**主要な処理内容**：
1. 開発用プラグイン（language-*/index.js）のパターンでプラグインファイルを検索
2. 本番用プラグイン（plugins/*.js）のパターンでプラグインファイルを検索
3. 各プラグインからパーサー、プリンター、言語定義、オプションを抽出
4. import文とexport文を含むJavaScriptコードを生成
5. Prettierでフォーマット後、定義ファイルとして出力

**前後の処理との関連**：本バッチで生成されたプラグイン定義ファイルは、build.jsでのビルド時にソースコードの一部として使用されます。プラグイン構成の変更時は本バッチを再実行してから、ビルドを行う必要があります。

**影響範囲**：src/main/plugins/builtin-plugins/配下のdevelopment-plugins.jsおよびproduction-plugins.jsファイル。これらはPrettierのコアエントリーポイントから参照されます。

## バッチ種別

コード生成 / メタプログラミング

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（プラグイン変更時） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動 / CI/CD |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | Node.jsがインストールされていること |
| 依存パッケージ | yarn installにより依存パッケージがインストール済みであること |
| プラグインソース | src/language-*/配下にプラグインソースコードが存在すること |

### 実行可否判定

プラグインファイルが存在しない場合は空の配列が生成されますが、エラーにはなりません。

## 入力仕様

### 入力パラメータ

本バッチはコマンドライン引数を受け取りません。

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | - |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| src/language-*/index.js | JavaScript | 開発用プラグインのエントリーポイント |
| src/plugins/*.js | JavaScript | 本番用プラグインファイル |
| src/language-*/languages.js | JavaScript | 言語定義ファイル |
| src/language-*/languages.evaluate.js | JavaScript | 評価用言語定義ファイル |
| src/language-*/options.js | JavaScript | オプション定義ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| src/main/plugins/builtin-plugins/development-plugins.js | JavaScript | 開発用プラグイン定義 |
| src/main/plugins/builtin-plugins/production-plugins.js | JavaScript | 本番用プラグイン定義 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | development-plugins.js, production-plugins.js |
| 出力先 | src/main/plugins/builtin-plugins/ |
| 文字コード | UTF-8 |
| 区切り文字 | N/A（JavaScriptファイル） |

## 処理フロー

### 処理シーケンス

```
1. プラグインファイル設定の定義
   └─ 開発用・本番用の2種類のパターンを定義
2. globでプラグインファイルを検索
   └─ fs.glob()で該当ファイルを列挙
3. 各プラグインの解析
   └─ dynamic importでモジュールを読み込み
   └─ parsers, printers, languages, optionsを抽出
4. import文の生成
   └─ 相対パスを計算してimport文を構築
5. export文の生成
   └─ toLazyLoadPlugins形式でプラグイン配列を生成
6. コードフォーマット
   └─ Prettier自身でフォーマット（parser: meriyah）
7. ファイル出力
   └─ fs.writeFileでファイルに書き込み
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[プラグインファイル設定読み込み]
    B --> C[開発用プラグイン処理]
    C --> D[fs.globでファイル検索]
    D --> E[各プラグインをimport]
    E --> F[parsers/printers/languages/options抽出]
    F --> G[import文生成]
    G --> H[export文生成]
    H --> I[Prettierでフォーマット]
    I --> J[ファイル出力]
    J --> K[本番用プラグイン処理]
    K --> L[同様の処理を実行]
    L --> M[バッチ終了]
```

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

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

本バッチはデータベースを使用しません。

### テーブル別操作詳細

N/A

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Invalid plugin name | プラグイン名が有効なJavaScript識別子でない | プラグインディレクトリ名を修正 |
| - | Unknown category | 未知のカテゴリディレクトリが存在 | カテゴリ定義を確認・追加 |
| - | Can not locate entry | languages/optionsのエントリが見つからない | プラグイン構造を確認 |

### リトライ仕様

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

### 障害時対応

エラー発生時は例外がスローされ、処理が中断します。エラーメッセージに基づきプラグインの構造や命名を確認・修正後、再実行してください。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（ファイルシステム操作のみ） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | プラグイン数（約10〜20個） |
| 目標処理時間 | 数秒 |
| メモリ使用量上限 | Node.jsデフォルト制限に依存 |

## 排他制御

同時実行は推奨されません。出力ファイルへの書き込みが競合する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| なし | - | 本バッチは標準出力へのログを出力しません |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| なし | - | エラー時は例外として伝播 |

## 備考

- 生成されたファイルの先頭には「Generated file, do NOT edit」コメントが挿入される
- estreeプラグインはjsプラグインから分離して生成される（PR #18481対応）
- Prettierのmeriyahパーサーを使用してコードをフォーマット
- toLazyLoadPlugins関数による遅延ロードで起動時間を最適化
- @babel/typesのisValidIdentifierでプラグイン名の妥当性を検証
