# バッチ設計書 7-examples/buildAll.js

## 概要

本ドキュメントは、全サンプルプロジェクトの一括ビルドスクリプト `examples/buildAll.js` の設計仕様を定義するものである。examplesディレクトリ内の各サンプルのbuild.jsを順次実行する。

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

`examples/buildAll.js` は、webpackプロジェクトのexamplesディレクトリ配下にある全てのサンプルプロジェクトを一括でビルドするためのスクリプトである。`examples/examples.js` モジュールにより検出された全サンプルディレクトリに対して、順次 `node build.js` を実行する。さらに、persistent-cachingを含むサンプルに対しては2回目のビルドを追加で実行する。

**業務上の目的・背景**：webpackのexamplesディレクトリには、webpackの各機能を示すサンプルプロジェクトが多数含まれている。これらのサンプルはドキュメンテーションとして機能するため、各サンプルのREADME.mdを最新のビルド結果で更新する必要がある。このスクリプトは全サンプルを一括でビルドし、READMEを再生成するために使用される。

**バッチの実行タイミング**：npm script `build:examples`（`cd examples && node buildAll.js`）として実行される。サンプルの更新やwebpackのバージョンアップ時に手動で実行される。

**主要な処理内容**：
1. `examples/examples.js` から全サンプルディレクトリの一覧を取得する
2. persistent-cachingを含むサンプルを追加で2回目ビルド対象として登録する
3. 各サンプルディレクトリで `cd {dirname} && node build.js` を同期的に順次実行する
4. ビルド進捗を `[n/total]` 形式で表示する
5. 全サンプルのビルド完了後、失敗したサンプルがあればエラーをスローする

**前後の処理との関連**：各サンプルの `build.js` は内部的に `examples/build-common.js`（No.8）を使用してwebpackビルドとREADME.md生成を行う。npm script `build:examples` として登録されている。

**影響範囲**：examplesディレクトリ配下の全サンプルプロジェクトのdistディレクトリおよびREADME.mdファイル。

## バッチ種別

ビルド / ドキュメント生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（サンプル更新時やバージョンアップ時） |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動（npm run build:examples） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.jsランタイム | Node.jsがインストールされていること |
| webpack-cli | webpack-cliがインストールされていること（各サンプルのビルドで使用） |
| webpackパッケージ | webpackがインストールされていること |
| examplesディレクトリ | template.mdを含むサンプルディレクトリが存在すること |

### 実行可否判定

特別な実行可否判定ロジックはない。`examples/examples.js` が返すサンプル一覧に基づいて処理が実行される。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| examples/examples.js | JavaScriptモジュール | サンプルディレクトリ一覧を返すモジュール |
| 各サンプルのbuild.js | JavaScriptファイル | 各サンプルのビルドスクリプト |
| 各サンプルのtemplate.md | Markdownファイル | README.md生成用テンプレート |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 各サンプルのdist/ | ビルド成果物 | webpackビルドの出力 |
| 各サンプルのREADME.md | Markdownファイル | ビルド結果を含むREADMEファイル |
| 標準出力（stdout） | テキスト | ビルド進捗メッセージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | README.md（各サンプルディレクトリ内） |
| 出力先 | 各サンプルディレクトリ |
| 文字コード | UTF-8 |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. examples/examples.jsからサンプルディレクトリ一覧を取得
   └─ examplesディレクトリ配下でtemplate.mdを含むディレクトリを再帰的に検索（深さ2まで）
   └─ ソート済みの配列として返却
2. persistent-cachingサンプルの2回目ビルド登録
   └─ ディレクトリ名にpersistent-cachingを含むサンプルをフィルタ
   └─ コマンドリストの末尾に追加
3. 各コマンドを同期的に順次実行
   └─ child_process.execSyncで "cd {dirname} && node build.js" を実行
   └─ 進捗を [n/total] 形式で表示
   └─ エラー発生時はcatchして失敗カウントをインクリメント（処理は継続）
4. 結果報告
   └─ "done" メッセージを表示
   └─ 失敗があればエラーをスロー（"{n} examples failed"）
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[examples.jsからサンプル一覧取得]
    B --> C[persistent-cachingサンプルの2回目ビルド登録]
    C --> D[コマンドリスト生成]
    D --> E{次のコマンドあり?}
    E -->|Yes| F[進捗表示]
    F --> G[cd dirname && node build.js 実行]
    G --> H{ビルド成功?}
    H -->|Yes| E
    H -->|No| I[失敗カウント++、エラー表示]
    I --> E
    E -->|No| J[done表示]
    J --> K{失敗あり?}
    K -->|Yes| L[エラースロー]
    K -->|No| M[バッチ正常終了]
    L --> M
```

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

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

本バッチはデータベースを操作しない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| Error | ビルド失敗 | いずれかのサンプルのbuild.jsが失敗 | 失敗したサンプルのエラーログを確認して修正 |
| Error | 全体失敗 | 1つ以上のサンプルが失敗した場合にスローされる | 各サンプルのエラーを個別に修正 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（個別サンプルの失敗はスキップして継続） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

個別サンプルのビルド失敗は、失敗したサンプルのエラーログを確認して原因を特定する。webpack-cliがインストールされていることを確認する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（データベース操作なし） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | examplesディレクトリ内の全サンプル数（数十〜百程度） |
| 目標処理時間 | サンプル数とそれぞれのビルド複雑さに依存（数分〜十数分） |
| メモリ使用量上限 | 各ビルドは個別のchild_processで実行されるため、親プロセスのメモリ使用量は限定的 |

## 排他制御

排他制御は行わない。全サンプルのビルドは同期的（順次）に実行される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | 各サンプルビルド開始時 | "[n/total] cd {dirname} && node build.js" |
| エラーログ | ビルド失敗時 | execSyncのエラー出力 |
| 完了ログ | 全サンプルビルド完了時 | "done" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| N/A | N/A | N/A（監視設定は未実装） |

## 備考

- npm scriptの `"build:examples": "cd examples && node buildAll.js"` として登録されている
- child_process.execSyncを使用して同期的にビルドを実行するため、各ビルドは順次処理される
- persistent-cachingサンプルは2回ビルドされる（1回目でキャッシュ生成、2回目でキャッシュ利用の動作確認）
- 個別サンプルのビルド失敗は処理を中断せず、失敗カウントを記録して全サンプルの処理後にエラーをスローする
- examples/examples.jsは、examplesディレクトリ配下を深さ2まで再帰探索し、template.mdを含むディレクトリを一覧として返す
- encoding: "utf8" オプションが指定されているため、子プロセスの出力はUTF-8文字列として処理される
