# バッチ設計書 5-build

## 概要

本ドキュメントは、Cakefileに定義された `build` タスクの設計仕様を記述したものです。CoffeeScriptコンパイラをソースからビルドします。

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

`cake build` コマンドは、CoffeeScriptコンパイラをソースコードからビルドする中核タスクです。Jisonパーサーの生成とCoffeeScriptソースファイルのコンパイルを含む完全ビルドを実行します。

**業務上の目的・背景**：CoffeeScriptコンパイラ自体がCoffeeScriptで書かれている（セルフホスティング）ため、ソースコードの変更を反映するにはコンパイラの再ビルドが必要です。このタスクは、src/ディレクトリのCoffeeScriptソースをlib/coffeescript/配下のJavaScriptファイルにコンパイルし、grammar.coffeeからJisonを使用してパーサーを生成します。開発者がソースコードを変更した後、この変更を実行可能なコンパイラに反映するための必須プロセスです。

**バッチの実行タイミング**：随時（手動実行）。コンパイラのソースコードを変更した後、テストや動作確認の前に実行します。リリースプロセスの一部としても実行されます。

**主要な処理内容**：
1. Jisonパーサーのビルド（buildParser関数）
   - grammar.coffeeからパーサールールを読み込み
   - Jisonを使用してparser.jsを生成
2. CoffeeScriptソースのコンパイル（buildExceptParser関数）
   - src/配下の.coffeeファイルを収集
   - coffeeコマンドでJavaScriptにコンパイル
   - lib/coffeescript/配下に出力

**前後の処理との関連**：`build:parser` および `build:except-parser` タスクの両方を実行する統合タスクです。`build:full` タスクはbuildを2回実行してセルフビルドを検証します。テストやブラウザビルドの前に実行される必要があります。

**影響範囲**：lib/coffeescript/配下の全JavaScriptファイルが更新されます。既存のファイルは上書きされます。

## バッチ種別

ビルド処理 / コンパイル

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | なし（手動実行） |
| 実行曜日 | なし |
| 実行日 | なし |
| トリガー | 手動 / リリースプロセス |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js 6以上 | ビルド実行に必要なランタイム |
| Jisonモジュール | パーサー生成に必要（devDependencies） |
| ソースファイル | src/配下のCoffeeScriptソースファイル |
| 既存コンパイラ | lib/coffeescript/配下の動作するコンパイラ |

### 実行可否判定

1. Node.jsランタイムの存在確認
2. Jisonモジュールのインストール確認
3. src/ディレクトリの存在確認
4. lib/coffeescript/の既存コンパイラの動作確認

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | cake buildは引数を受け付けません |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| src/*.coffee | CoffeeScript | コンパイラのソースコード |
| src/*.litcoffee | Literate CoffeeScript | リテレートスタイルのソースコード |
| lib/coffeescript/grammar.js | JavaScript | パーサー生成のための文法定義 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| lib/coffeescript/*.js | JavaScript | コンパイル済みコンパイラモジュール |
| lib/coffeescript/parser.js | JavaScript | Jison生成のパーサー |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 元ファイル名の拡張子を.jsに変更 |
| 出力先 | lib/coffeescript/ |
| 文字コード | UTF-8 |
| 区切り文字 | なし |

## 処理フロー

### 処理シーケンス

```
1. cake buildコマンド実行
   └─ Cakefileのbuildタスクを呼び出し
2. build関数の実行
   └─ buildParser()とbuildExceptParser()を順次実行
3. buildParser()の実行
   └─ utilモジュールをglobalに拡張
   └─ jisonモジュールをrequire
   └─ lib/coffeescript/grammar.jsからパーサーを生成
   └─ lib/coffeescript/parser.jsに書き出し
4. buildExceptParser()の実行
   └─ src/配下の.coffee/.litcoffeeファイルを収集
   └─ coffee -c -o lib/coffeescript でコンパイル
5. コールバック呼び出し（あれば）
   └─ 完了通知
```

### フローチャート

```mermaid
flowchart TD
    A[cake build] --> B[build関数呼び出し]
    B --> C[buildParser]
    C --> D[globalにutil拡張]
    D --> E[jisonモジュールロード]
    E --> F[grammar.jsからパーサー生成]
    F --> G[parser.js書き出し]
    G --> H[buildExceptParser]
    H --> I[src/ファイル収集]
    I --> J[.coffee/.litcoffeeフィルタ]
    J --> K[coffee -c -o lib/coffeescript]
    K --> L[コンパイル完了]
    L --> M{コールバックあり?}
    M -->|Yes| N[コールバック実行]
    M -->|No| O[終了]
    N --> O
```

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

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

本バッチはデータベース操作を行いません。

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | 依存エラー | jisonモジュールが未インストール | npm install |
| 1 | 構文エラー | ソースファイルのCoffeeScript構文が不正 | ソースコードを修正 |
| 1 | パーサー生成エラー | grammar.coffeeの文法定義が不正 | 文法定義を修正 |
| 1 | ファイルエラー | src/ディレクトリが存在しない | プロジェクト構造を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | なし |
| リトライ対象エラー | なし |

### 障害時対応

- 構文エラー発生時：エラーメッセージを確認し、該当ソースファイルを修正
- パーサー生成エラー：grammar.coffeeの文法定義を確認
- 既存コンパイラが壊れた場合：`git checkout lib/*` で復元

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし |
| コミットタイミング | なし |
| ロールバック条件 | なし（git checkoutで手動復元） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 約10ファイル |
| 目標処理時間 | 数秒 |
| メモリ使用量上限 | Node.jsデフォルト制限に従う |

## 排他制御

- 同時実行は推奨されない（出力ファイルの競合の可能性）
- ファイル書き込みはNode.jsのfsモジュールに依存

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| なし | - | buildタスク自体はログを出力しない |

## 監視・アラート

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

## 備考

- CoffeeScriptコンパイラはセルフホスティング（CoffeeScriptで書かれたCoffeeScriptコンパイラ）です
- buildParser()は、helpers.extend(global, require 'util')でglobalにutilを拡張します
- パーサー生成時、moduleMainオプションは空関数に設定されます（スタンドアロン実行は想定されていない）
- ソースファイルの収集は、fs.readdirSyncで同期的に行われます
- coffeeコマンドは、run関数を通じてspawnで実行されます
- ビルドが失敗しても、既存のlib/配下のファイルは部分的に更新される可能性があります
