# バッチ設計書 4-watch.mjs

## 概要

本ドキュメントは、Jestモノレポにおけるファイル監視・自動再ビルドバッチ `watch.mjs` の設計仕様を記載したものです。このバッチはWebpackのwatchモードを使用して、ソースファイルの変更を検知し、変更があった際に自動的にパッケージを再ビルドします。

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

**業務上の目的・背景**：開発者がソースコードを頻繁に変更する開発フェーズでは、毎回手動で `yarn build:js` を実行するのは非効率です。本バッチは、ファイルシステムを監視し、TypeScript ソースファイルの変更を検知して自動的にJavaScriptへのトランスパイルを行うことで、開発者の生産性を大幅に向上させます。変更後数秒でビルドが完了するため、即座にテスト実行や動作確認が可能になります。

**バッチの実行タイミング**：開発者が `yarn watch` コマンドを実行した際に起動し、手動で停止（Ctrl+C）するまで常駐します。開発セッション中はバックグラウンドで継続的に動作することを想定しています。

**主要な処理内容**：
1. `createWebpackConfigs()` で全パッケージのWebpack設定を取得
2. Webpack コンパイラを初期化
3. `compiler.watch()` でファイル監視を開始
4. ファイル変更検知時に自動でバンドル処理を実行
5. ビルド結果（成功/エラー/警告）をコンソールに出力

**前後の処理との関連**：`yarn install` による依存関係のインストールが前提です。本バッチ実行中は `yarn build:js` を並行して実行する必要はありません。TypeScript 型定義の変更がある場合は、別途 `yarn build:ts` の実行が必要です。

**影響範囲**：全パッケージの `packages/*/build/` ディレクトリにビルド成果物が出力されます。監視対象は `packages/*/src/` 配下の TypeScript ファイルです。

## バッチ種別

開発支援 / ファイル監視 / 自動ビルド

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（開発者操作時） |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | `yarn watch` コマンド実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | ^18.14.0 \|\| ^20.0.0 \|\| ^22.0.0 \|\| >=24.0.0 |
| 依存関係インストール済み | `yarn install` が完了していること |
| パッケージ構造 | `packages/*/src/index.ts` が存在すること |

### 実行可否判定

- `createWebpackConfigs()` で有効なWebpack設定が1つ以上存在すること
- ファイルシステムの監視が可能な環境であること

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| packages/*/src/*.ts | TypeScript | 監視対象のソースファイル |
| packages/*/package.json | JSON | パッケージメタデータ |
| babel.config.js | JavaScript | Babelトランスパイル設定 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| packages/*/build/index.js | JavaScript (CommonJS) | メインエントリポイント |
| packages/*/build/*.js | JavaScript (CommonJS) | 追加エントリポイント |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | `[name].js`（Webpack output.filename設定） |
| 出力先 | `packages/*/build/` |
| 文字コード | UTF-8 |
| モジュール形式 | CommonJS |

## 処理フロー

### 処理シーケンス

```
1. Webpack設定の取得
   └─ createWebpackConfigs() で全パッケージの設定を取得
2. Webpackコンパイラの初期化
   └─ webpack(configs) でマルチコンパイラを生成
3. 初期ビルドメッセージ出力
   └─ "Bundling packages" を出力
4. ファイル監視開始
   └─ compiler.watch({}, callback) で監視を開始
5. 変更検知時のコールバック実行（ループ）
   ├─ 初回ビルド完了時: "Watching for changes…" を出力
   ├─ エラー発生時: エラー詳細を出力
   ├─ 警告発生時: 警告詳細を出力
   └─ 成功時: "Rebuilt packages" を出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[createWebpackConfigs実行]
    B --> C[Webpackコンパイラ初期化]
    C --> D[Bundling packages メッセージ出力]
    D --> E[compiler.watch 開始]
    E --> F{ファイル変更検知}
    F --> G{初回ビルド?}
    G -->|はい| H[Watching for changes… 出力]
    G -->|いいえ| I{エラー発生?}
    H --> I
    I -->|はい| J[エラーメッセージ出力]
    I -->|いいえ| K{警告発生?}
    J --> F
    K -->|はい| L[警告メッセージ出力]
    K -->|いいえ| M[Rebuilt packages 出力]
    L --> F
    M --> F
    F -->|Ctrl+C| N[バッチ終了]
```

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

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

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| Webpack Error | コンパイルエラー | TypeScript 構文エラーや依存関係エラー | エラーメッセージを確認しソースコードを修正 |
| Webpack Warning | コンパイル警告 | 非推奨構文の使用など | 警告内容を確認し対応 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 自動（ファイル変更で再実行） |
| リトライ間隔 | ファイル変更検知時 |
| リトライ対象エラー | 全てのビルドエラー |

### 障害時対応

1. エラーメッセージを確認し、問題のあるソースファイルを特定
2. ソースコードの構文エラーやimportエラーを修正
3. ファイル保存で自動的に再ビルドが実行される

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 変更されたパッケージのみ |
| 目標処理時間 | 数秒（インクリメンタルビルド） |
| メモリ使用量上限 | Node.jsデフォルトヒープサイズ |

## 排他制御

- `yarn build:js` との同時実行は非推奨（ファイル書き込み競合）
- 複数の watch プロセスの同時実行は非推奨

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | `Bundling packages` |
| 監視開始ログ | 初回ビルド完了時 | `-> Watching for changes…` |
| 成功ログ | 再ビルド成功時 | `-> Rebuilt packages` |
| エラーログ | エラー発生時 | `error [エラーメッセージ]` |
| 警告ログ | 警告発生時 | `warning [警告メッセージ]` |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| N/A | - | - |

※ 開発用バッチのため、本番監視は不要

## 備考

- 本バッチは開発時のホットリロード用途
- ESM (.mjs) ファイルは生成されない（build.mjs との違い）
- TypeScript 型定義の変更は反映されないため、別途 `yarn build:ts` が必要
- ファイル監視にはOSのネイティブ機能を使用（inotify, FSEvents等）
- 大量のファイル変更が同時に発生した場合、バンドル処理は1回にまとめられる
