# 機能設計書 1-jest

## 概要

本ドキュメントは、Jestテスティングフレームワークのメインエントリポイントパッケージ「jest」の機能設計を記述したものである。

### 本機能の処理概要

jestパッケージは、Jestフレームワーク全体のエントリポイントとして機能し、ユーザーが`import jest from 'jest'`または`require('jest')`でインポートした際に、必要なすべてのAPIを提供する統合パッケージである。

**業務上の目的・背景**：JavaScriptおよびTypeScriptプロジェクトにおいて、テスト実行環境の統一的なエントリポイントを提供することが本パッケージの目的である。開発者が個別のパッケージ（jest-cli、@jest/core、expectなど）を個別にインストール・インポートする必要をなくし、単一のパッケージで全ての機能にアクセスできるようにすることで、導入コストを削減し、開発体験を向上させる。

**機能の利用シーン**：プログラマティックにJestを実行する必要がある場合（CI/CDパイプライン内でのカスタムテスト実行、IDEプラグイン開発、テストランナーのラッパー作成など）に利用される。また、Node.jsスクリプトからJestを直接呼び出す際のAPIエンドポイントとしても使用される。

**主要な処理内容**：
1. jest-cliからrun関数を再エクスポートし、CLIと同等のテスト実行機能を提供
2. @jest/coreからSearchSource、TestScheduler、TestWatcher、createTestSchedulerをエクスポートし、テスト検索・スケジューリング・監視機能を提供
3. @jest/typesからConfig型をエクスポートし、設定の型定義を提供
4. getVersionメソッドでJestのバージョン情報を提供

**関連システム・外部連携**：本パッケージ自体は他の内部Jestパッケージ（jest-cli、@jest/core、@jest/types）への依存のみであり、外部システムとの直接的な連携はない。

**権限による制御**：特になし。ファイルシステムへのアクセス権限はjest-runtimeおよびjest-configが担当する。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| N/A | N/A | N/A | 本機能はCLIパッケージのラッパーであり、画面は存在しない |

## 機能種別

API統合 / エクスポート集約

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| argv | Config.Argv | No | テスト実行時のコマンドライン引数 | jest-cliで検証 |
| projects | Array<string> | No | テスト対象プロジェクトのパス配列 | 存在するパスであること |

### 入力データソース

- コマンドライン引数（process.argv経由）
- プログラマティックなAPI呼び出し

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| run | Function | テスト実行関数 |
| SearchSource | Class | テストファイル検索クラス |
| TestScheduler | Class | テストスケジューリングクラス |
| TestWatcher | Class | テスト監視クラス |
| createTestScheduler | Function | テストスケジューラ作成関数 |
| getVersion | Function | Jestバージョン取得関数 |
| Config | Type | 設定型定義 |

### 出力先

Node.jsモジュールシステムを通じて、インポート元のコードに対してAPIを提供

## 処理フロー

### 処理シーケンス

```
1. モジュールインポート
   └─ 各依存パッケージ（jest-cli、@jest/core、@jest/types）をインポート
2. API再エクスポート
   └─ 各パッケージの公開APIを統合してエクスポート
3. run関数実行（呼び出し時）
   └─ jest-cliのrunメソッドに処理を委譲
```

### フローチャート

```mermaid
flowchart TD
    A[ユーザーがjestをインポート] --> B[モジュール初期化]
    B --> C{どのAPIを使用?}
    C -->|run| D[jest-cli.run実行]
    C -->|SearchSource| E[テストファイル検索]
    C -->|TestScheduler| F[テストスケジューリング]
    C -->|getVersion| G[バージョン情報返却]
    D --> H[テスト実行結果]
    E --> I[テストファイル一覧]
    F --> J[スケジュールされたテスト]
    G --> K[バージョン文字列]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 統合エクスポート | すべての公開APIは単一のエントリポイントから提供される | 常時 |
| BR-002 | バージョン一貫性 | getVersionは常にpackage.jsonのバージョンと一致する | 常時 |

### 計算ロジック

計算ロジックは本パッケージには存在しない（APIの集約のみ）

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

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

データベース操作は本パッケージでは行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| MODULE_NOT_FOUND | インポートエラー | 依存パッケージが見つからない | npm install jestを実行 |

### リトライ仕様

本パッケージ自体にリトライ処理は存在しない

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

トランザクション処理は本パッケージには存在しない

## パフォーマンス要件

モジュールのインポート時間のみが考慮対象となる。依存パッケージの遅延ロードは行っていないため、初回インポート時に全依存が読み込まれる。

## セキュリティ考慮事項

本パッケージ自体にはセキュリティ上の特別な考慮事項はない。実際のテスト実行時のセキュリティはjest-runtime等の下位パッケージが担当する。

## 備考

- 本パッケージはJestフレームワークの「ファサード」として機能する
- バージョン番号はpackage.jsonから動的に取得される

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

本パッケージはAPI集約のみを行うため、主要なデータ構造は@jest/typesパッケージで定義されている。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Config.ts | `packages/@jest/types/src/Config.ts` | Jestの設定型定義を理解する |

**読解のコツ**: TypeScriptのインターフェースとして設定オプションが定義されており、GlobalConfigとProjectConfigの違いを把握することが重要。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | index.ts | `packages/jest/src/index.ts` | 全てのエクスポートの起点 |

**主要処理フロー**:
1. **8-9行目**: jest-cliからrunメソッドをインポート・再エクスポート
2. **10-16行目**: @jest/coreから各クラス・関数をインポート・再エクスポート
3. **17行目**: @jest/typesからConfig型をインポート・再エクスポート
4. **19-21行目**: getVersion関数でpackage.jsonからバージョンを取得

#### Step 3: 依存パッケージの役割を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | jest-cli/src/run.ts | `packages/jest-cli/src/run.ts` | run関数の実装 |
| 3-2 | @jest/core/src/index.ts | `packages/jest-core/src/index.ts` | コア機能のエクスポート |

### プログラム呼び出し階層図

```
jest/src/index.ts
    │
    ├─ jest-cli/src/run.ts
    │      └─ @jest/core/src/cli/index.ts
    │             └─ runJest.ts
    │
    ├─ @jest/core/src/SearchSource.ts
    │
    ├─ @jest/core/src/TestScheduler.ts
    │
    └─ @jest/core/src/TestWatcher.ts
```

### データフロー図

```
[入力]               [処理]                    [出力]

ユーザーコード ───▶ jest/index.ts ───▶ jest-cli/run
      │                                      │
      │                                      ▼
      │                              @jest/core機能群
      │                                      │
      └──────────────────────────────────────▼
                                     テスト実行結果
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| index.ts | `packages/jest/src/index.ts` | ソース | メインエントリポイント |
| package.json | `packages/jest/package.json` | 設定 | パッケージ定義・バージョン情報 |
| run.ts | `packages/jest-cli/src/run.ts` | ソース | CLI実行機能 |
| Config.ts | `packages/@jest/types/src/Config.ts` | 型定義 | 設定型定義 |
