# バッチ設計書 16-doc:test:watch

## 概要

本ドキュメントは、CoffeeScriptプロジェクトにおける`doc:test:watch`タスクの設計書です。このバッチは、テストファイルの変更を監視し、変更を検知した際に自動的にブラウザテストページを再ビルドする開発支援ツールです。

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

このバッチは、`doc:test`タスクの監視モード版です。テストファイルおよびテストページテンプレートの変更をリアルタイムで監視し、変更が検知されると自動的にテストHTMLページを再生成します。テスト開発時のライブプレビュー環境を提供します。

**業務上の目的・背景**：CoffeeScriptのテストを開発・修正する際、変更の都度手動でテストページをビルドするのは非効率です。このバッチを使用することで、テストファイルを保存するだけで自動的にHTMLテストページが再生成され、ブラウザをリロードすれば即座に変更を確認できます。これによりテスト開発のフィードバックサイクルが大幅に短縮されます。

**バッチの実行タイミング**：テスト開発者が手動で起動し、編集セッション中は継続的に実行されます。監視対象ファイルに変更が発生した際に、自動的に再ビルドが実行されます。

**主要な処理内容**：
1. 初回起動時にテストページの完全ビルドを実行
2. `documentation/site/test.html`テンプレートの変更を監視
3. `test/`ディレクトリの変更を監視
4. 変更検知時にrenderTest関数を再実行してHTMLを再生成

**前後の処理との関連**：`doc:test`タスクと同じbuildDocTests関数を使用しますが、watch=trueフラグで呼び出されます。

**影響範囲**：`docs/vX/test.html`が更新されます。

## バッチ種別

開発支援 / テストページ継続的ビルド

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（テスト開発時） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動起動後、ファイル変更イベント |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | Node.jsがインストールされていること |
| 依存パッケージ | `npm install`が完了していること |
| テストファイル | test/配下にテストファイルが存在すること |
| テンプレート | documentation/site/test.htmlが存在すること |

### 実行可否判定

- `documentation/site/test.html`が存在すること
- `test/`ディレクトリが存在すること

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| documentation/site/test.html | HTML(テンプレート) | テストページテンプレート |
| test/support/helpers.coffee | CoffeeScript | テストヘルパー関数 |
| test/*.coffee | CoffeeScript | テストファイル |
| test/*.litcoffee | Literate CoffeeScript | 文芸的テストファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| docs/vX/test.html | HTML | ブラウザテストページ |
| 標準出力 | テキスト | ビルド結果・監視ステータス |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | test.html |
| 出力先 | docs/vX/ |
| 文字コード | UTF-8 |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. 初期ビルド実行
   └─ renderTest()を呼び出してHTMLを生成
2. ファイル監視設定
   └─ testFileとtestsSourceFolderにfs.watchを設定
3. 監視開始ログ出力
   └─ "watching..."を表示
4. 変更検知ループ
   └─ 変更イベント発生時にrenderTest()を再実行
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[初期ビルド実行]
    B --> C[監視対象設定]
    C --> D[ファイル監視開始]
    D --> E["watching..."ログ出力]
    E --> F{変更検知?}
    F -->|なし| F
    F -->|変更あり| G[renderTest実行]
    G --> H[HTML再生成]
    H --> F
```

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

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

該当なし（ファイルシステム操作のみ）

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイル読み込みエラー | テンプレートまたはテストファイルが存在しない | ファイルパスを確認 |
| - | テンプレートエラー | テンプレート構文エラー | テンプレートを修正 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（次のファイル変更時に再実行） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

- ビルドエラー発生時：エラーメッセージを確認し、ソースファイルを修正して保存すると自動的に再ビルドされる
- プロセス停止時：`cake doc:test:watch`で再起動

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | テストファイル数十個 |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

- 同時実行：不可（同一ディレクトリで複数起動すべきでない）
- ロック仕様：なし

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 完了ログ | HTML出力完了時 | "compiled documentation/site/test.html → docs/vX/test.html" |
| 監視ログ | 監視開始時 | "watching..." |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 該当なし | - | - |

## 備考

- 監視間隔は200msに設定されている
- 2つのターゲットが監視対象
  - `testFile`（documentation/site/test.html）
  - `testsSourceFolder`（test/）
- 監視中はプロセスが終了せず、Ctrl+Cで停止する必要がある
- テストヘルパー（test/support/helpers.coffee）も変更時に再読み込みされる
