# バッチ設計書 13-generate-unused-typescript-specifiers

## 概要

本ドキュメントは、Prettierプロジェクトにおける `generate-unused-typescript-specifiers.js` バッチの設計仕様を定義します。このバッチは、TypeScriptパッケージから未使用のエクスポートを特定し、ビルド時に除外するためのリストを生成・更新するスクリプトです。

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

このバッチは、Prettierのビルドサイズを最適化するために、TypeScriptパッケージの未使用エクスポートを特定します。esbuildを使用してモジュール変換後のコードを検証し、未使用として検出されたエクスポートのリストを更新します。

**業務上の目的・背景**：PrettierはTypeScriptパッケージを利用していますが、その全機能を使用しているわけではありません。ビルド成果物のサイズを削減するため、使用していないエクスポートを特定し、ビルド時に除外することで、最終的なバンドルサイズを最小化します。これにより、ダウンロード時間の短縮とメモリ使用量の削減が実現できます。

**バッチの実行タイミング**：TypeScriptパッケージのバージョン更新時、またはPrettierのTypeScript関連コードを大幅に変更した時に手動で実行します。

**主要な処理内容**：
1. TypeScriptモジュールのソースコードを読み込む
2. modifyTypescriptModule関数でコードを変換
3. esbuildでトランスフォームし、未宣言の変数（＝除外されたエクスポート）を検出
4. 既存の未使用リストと新規検出リストをマージ
5. typescript-unused-specifiers.jsファイルを更新

**前後の処理との関連**：このバッチの出力は、build.jsバッチで使用され、ビルド時のTree Shakingに活用されます。TypeScriptパッケージの更新後に実行する必要があります。

**影響範囲**：`scripts/build/hacks/typescript-unused-specifiers.js`ファイルが更新されます。この変更は後続のビルドプロセスに影響を与えます。

## バッチ種別

コード生成 / ビルド最適化

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | Node.js実行環境が利用可能であること |
| TypeScript | typescriptパッケージがインストール済みであること |
| 依存パッケージ | esbuild, import-meta-resolve, outdent, prettierがインストール済みであること |

### 実行可否判定

依存パッケージがすべてインストールされている場合に実行可能です。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| typescriptモジュール | JavaScript | TypeScriptパッケージのメインモジュール |
| typescript-unused-specifiers.js | JavaScript | 既存の未使用エクスポートリスト |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| scripts/build/hacks/typescript-unused-specifiers.js | JavaScript | 更新された未使用エクスポートリスト |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | typescript-unused-specifiers.js |
| 出力先 | scripts/build/hacks/ |
| 文字コード | UTF-8 |
| 形式 | ES Module（default export Set） |

## 処理フロー

### 処理シーケンス

```
1. TypeScriptモジュールの読み込み
   └─ import-meta-resolveでモジュールパスを解決
   └─ ファイル内容を読み込む

2. モジュールの変換
   └─ modifyTypescriptModule関数でコードを変換
   └─ 変換後のコードとエクスポート情報を取得

3. 未使用エクスポートの検出
   └─ esbuild.transformSyncでJSトランスフォームを試行
   └─ エラーメッセージから未宣言変数を抽出
   └─ 未宣言変数を未使用エクスポートとして特定

4. リストのマージと検証
   └─ 既存の未使用リストと新規検出リストを結合
   └─ typescript名前空間に存在するもののみをフィルタリング
   └─ アルファベット順にソート

5. ファイル出力
   └─ outdentでテンプレートを生成
   └─ Prettierでフォーマット
   └─ typescript-unused-specifiers.jsに書き込み
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[TypeScriptモジュール読み込み]
    B --> C[modifyTypescriptModuleで変換]
    C --> D[esbuildでトランスフォーム]
    D --> E{変換エラー?}
    E -->|あり| F[エラーメッセージから未宣言変数抽出]
    E -->|なし| G[空リスト]
    F --> H[既存リストとマージ]
    G --> H
    H --> I[typescript名前空間でフィルタ]
    I --> J[ソート]
    J --> K[Prettierでフォーマット]
    K --> L[ファイル出力]
    L --> M[完了メッセージ出力]
    M --> N[バッチ終了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | モジュール解決エラー | TypeScriptパッケージが見つからない | yarn installを実行 |
| - | ファイル読み込みエラー | ファイルアクセス権限がない | 権限を確認 |

### リトライ仕様

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

### 障害時対応

1. TypeScriptパッケージが見つからない場合は`yarn install`を実行
2. ファイルアクセスエラーの場合は権限を確認

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1ファイル |
| 目標処理時間 | 数秒〜十数秒 |
| メモリ使用量上限 | 制限なし（TypeScriptモジュールは大きい） |

## 排他制御

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

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 完了ログ | 処理完了時 | "typescript-unused-specifiers.js updated." |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 実行エラー | 発生時 | 開発者への通知 |

## 備考

- このスクリプトはビルド最適化の一環として使用されます
- esbuildのエラーメッセージパターン（"XXX" is not declared in this file）に依存しています
- modifyTypescriptModule関数は別ファイル（scripts/build/hacks/modify-typescript-module.js）で定義されています
- ES Modules形式で実装されています
- 出力ファイルはSetオブジェクトをdefault exportする形式です
