# バッチ設計書 2-buildTs.mjs

## 概要

本ドキュメントは、Jestモノレポにおける TypeScript 定義ファイルビルドバッチ `buildTs.mjs` の設計仕様を記載したものです。このバッチは全パッケージの tsconfig.json を検証し、TypeScript コンパイラ（tsc）を使用して型定義ファイル（.d.ts）を生成・検証します。

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

**業務上の目的・背景**：Jest は TypeScript で記述されており、npm パッケージとして配布する際には JavaScript ファイルに加えて TypeScript の型定義ファイル（.d.ts）が必要です。これにより、TypeScript ユーザーは Jest を型安全に利用できます。本バッチは、各パッケージの依存関係が tsconfig.json の references に正しく反映されているかを検証し、一貫性のある型定義ファイルを生成することで、パッケージの品質を保証します。

**バッチの実行タイミング**：開発者が `yarn build:ts` コマンドを実行した際に随時実行されます。フルビルド（`yarn build`）の一部としても実行されます。CI/CD パイプラインでは、リリース準備時に自動実行されます。型定義に関わる変更を行った場合に実行が必要です。

**主要な処理内容**：
1. `getPackagesWithTsConfig()` で tsconfig.json を持つパッケージ一覧を取得
2. 各パッケージの package.json の `types` フィールドと `main` フィールドの整合性を検証
3. Jest 内部パッケージ間の依存関係と tsconfig.json の references の整合性を検証
4. `@jest/test-utils` の依存関係が正しく devDependencies に宣言されているか検証
5. `yarn tsc -b` コマンドで全パッケージの型定義ファイルをビルド
6. 生成された .d.ts ファイルを検証し、不正な型参照がないか確認
7. `@types/node` への依存が必要なパッケージを検出・検証

**前後の処理との関連**：`yarn build:js` によるJavaScriptビルドが完了した後に実行されることが多いです。後続処理として `bundleTs.mjs` による API Extractor を使用した型定義のバンドル処理があります。

**影響範囲**：tsconfig.json を持つ全パッケージの `build/` ディレクトリに .d.ts ファイルが出力されます。型定義に問題がある場合、TypeScript ユーザーのコンパイルエラーにつながります。

## バッチ種別

ビルド処理 / 型定義生成 / 検証処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（開発者操作時） |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | `yarn build:ts` コマンド実行 / CI/CDパイプライン |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | ^18.14.0 \|\| ^20.0.0 \|\| ^22.0.0 \|\| >=24.0.0 |
| 依存関係インストール済み | `yarn install` が完了していること |
| TypeScriptインストール済み | devDependencies に typescript が含まれること |
| tsconfig.json 存在 | 各パッケージに tsconfig.json が存在すること |

### 実行可否判定

- `getPackagesWithTsConfig()` で tsconfig.json を持つパッケージが1つ以上存在すること
- 各パッケージの package.json に `types` フィールドが定義されていること
- `types` フィールドと `main` フィールドの拡張子が整合していること（.js → .d.ts）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| 追加引数 | string[] | No | なし | process.argv.slice(2) で tsc に追加引数を渡せる |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| packages/*/tsconfig.json | JSON | 各パッケージのTypeScript設定 |
| packages/*/package.json | JSON | パッケージメタデータ（main, types, dependencies等） |
| packages/*/src/*.ts | TypeScript | ソースファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| packages/*/build/*.d.ts | TypeScript定義 | 型定義ファイル |
| packages/*/tsconfig.tsbuildinfo | JSON | TypeScriptビルドキャッシュ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | ソースファイル名に対応（*.ts → *.d.ts） |
| 出力先 | `packages/*/build/` |
| 文字コード | UTF-8 |
| 形式 | TypeScript 型定義ファイル |

## 処理フロー

### 処理シーケンス

```
1. パッケージ一覧取得
   └─ getPackagesWithTsConfig() で tsconfig.json を持つパッケージを列挙
2. ワークスペース情報取得
   └─ yarn workspaces list --json でワークスペース一覧を取得
3. 各パッケージの事前検証（ループ）
   ├─ types フィールドの存在確認
   ├─ main と types の整合性確認
   ├─ Jest 内部依存関係と references の整合性確認
   └─ @jest/test-utils の依存関係確認
4. TypeScript コンパイル実行
   └─ yarn tsc -b [パッケージディレクトリ...] を実行
5. 生成ファイル検証（並列処理）
   ├─ .d.ts ファイルを glob で検索
   ├─ 型参照ディレクティブの検証
   └─ @types/node 依存の検証
6. 完了通知
   └─ 成功/失敗メッセージを出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[パッケージ一覧取得]
    B --> C[ワークスペース情報取得]
    C --> D[各パッケージの検証ループ]
    D --> E{types フィールド存在?}
    E -->|なし| F[AssertionError]
    E -->|あり| G{main と types 整合?}
    G -->|不整合| H[AssertionError]
    G -->|整合| I{references 整合?}
    I -->|不整合| J[AssertionError]
    I -->|整合| K{@jest/test-utils 正しい?}
    K -->|不正| L[Error 送出]
    K -->|正常| M[次のパッケージ]
    M --> D
    D --> N[yarn tsc -b 実行]
    N --> O{コンパイル成功?}
    O -->|失敗| P[エラー出力]
    O -->|成功| Q[.d.ts ファイル検証]
    Q --> R{検証成功?}
    R -->|失敗| S[エラー出力]
    R -->|成功| T[成功メッセージ出力]
    T --> U[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | - | - | データベースへのアクセスなし |

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

データベース操作は発生しません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| AssertionError | types 不在 | package.json に types フィールドがない | types フィールドを追加 |
| AssertionError | main/types 不整合 | main と types の拡張子が対応しない | package.json を修正 |
| AssertionError | references 不整合 | tsconfig.json の references が依存関係と一致しない | tsconfig.json を修正 |
| Error | @jest/test-utils 不正 | dependencies に @jest/test-utils がある | devDependencies に移動 |
| Error | 型参照不正 | .d.ts に @types/node 以外の型参照がある | コードを修正 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認し、該当パッケージを特定
2. package.json の main/types フィールドを確認・修正
3. tsconfig.json の references を依存関係と同期
4. `yarn build-clean` でキャッシュクリア後、再実行

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | tsconfig.json を持つ全パッケージ |
| 目標処理時間 | 数分（フルビルドの一部） |
| 並列処理 | CPU コア数 - 1 で並列検証（pLimit 使用） |

## 排他制御

- 同時実行は推奨されない（tsbuildinfo ファイルへの同時書き込み）
- `yarn build:js` との並列実行は可能

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ビルド開始時 | `Building TypeScript definition files` |
| 成功ログ | ビルド成功時 | `Successfully built TypeScript definition files` |
| エラーログ | ビルド失敗時 | `Unable to build TypeScript definition files` |
| 検証開始ログ | 検証開始時 | `Validating TypeScript definition files` |
| 検証成功ログ | 検証成功時 | `Successfully validated TypeScript definition files` |
| 検証エラーログ | 検証失敗時 | `Unable to validate TypeScript definition files` |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 5分超過 | CI/CDパイプライン |
| 終了コード | 非0 | CI/CDパイプライン |

## 備考

- 本バッチは `yarn build` の一部として実行される（`yarn build:ts`）
- 型定義のみを扱う作業では `yarn build:js` は不要
- references の自動更新は行われないため、依存関係変更時は手動で tsconfig.json を更新する必要がある
- `@jest/test-utils` は常に devDependencies に配置する必要がある
