# バッチ設計書 1-coffee

## 概要

本ドキュメントは、CoffeeScriptコンパイラのコマンドラインインターフェース（CLI）である `coffee` コマンドの設計仕様を記述したものです。

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

`coffee` コマンドは、CoffeeScriptファイルをJavaScriptにコンパイル・実行するためのNode.js CLIツールです。ユーザーがコマンドラインからCoffeeScriptコードを操作するための主要なインターフェースを提供します。

**業務上の目的・背景**：CoffeeScriptはJavaScriptにコンパイルされる言語であり、開発者がより簡潔で読みやすいコードを書くことを可能にします。`coffee` コマンドは、この言語を実際に使用するための中核ツールであり、開発ワークフローにおいてソースコードのコンパイル、実行、監視を一元的に行う必要があります。このツールがなければ、CoffeeScriptを実用的に使用することは困難です。

**バッチの実行タイミング**：随時（手動実行）。開発者がCoffeeScriptファイルをコンパイルまたは実行したいときに任意のタイミングで実行されます。`--watch` オプション使用時は継続的に監視・実行されます。

**主要な処理内容**：
1. コマンドライン引数のパース（オプションとファイルパスの解析）
2. CoffeeScriptソースコードの読み込み
3. レキシカル解析（トークン化）
4. 構文解析（AST生成）
5. JavaScriptコードへのコンパイル
6. 出力処理（ファイル保存、標準出力、実行）
7. ソースマップの生成（オプション）
8. Babelトランスパイル（オプション）
9. ファイル監視とリコンパイル（--watchオプション時）

**前後の処理との関連**：このコマンドは独立して動作しますが、`cake` コマンドやnpmスクリプトから呼び出されることもあります。ビルドプロセスやテスト実行の前段階として使用されます。

**影響範囲**：ローカルファイルシステム上の.coffeeファイルと生成される.jsファイル。REPLモードではグローバルスコープに影響を与えます。

## バッチ種別

CLIツール / コンパイラ実行

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js 6以上 | ES6構文（分割代入等）をサポートするNode.jsランタイムが必要 |
| CoffeeScriptモジュール | lib/coffeescript配下のコンパイラモジュールが存在すること |
| 入力ファイル | .coffee/.litcoffee/.coffee.mdファイル、または標準入力 |

### 実行可否判定

1. Node.jsランタイムのバージョンチェック（ES6構文のサポート確認）
2. CoffeeScriptモジュールの存在確認（複数のパスを順次検索）
3. 入力ファイルまたはstdinの存在確認

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --ast | boolean | No | false | 抽象構文木をJSON形式で出力 |
| -b, --bare | boolean | No | false | トップレベル関数ラッパーなしでコンパイル |
| -c, --compile | boolean | No | false | JavaScriptにコンパイルして.jsファイルに保存 |
| -e, --eval | boolean | No | false | コマンドラインから文字列を入力として渡す |
| -h, --help | boolean | No | false | ヘルプメッセージを表示 |
| -i, --interactive | boolean | No | false | 対話型REPLを起動 |
| -j, --join [FILE] | string | No | なし | コンパイル前にソースを結合（非推奨） |
| -l, --literate | boolean | No | false | 入力をLiterate CoffeeScriptとして扱う |
| -m, --map | boolean | No | false | ソースマップを生成して.js.mapファイルに保存 |
| -M, --inline-map | boolean | No | false | ソースマップを出力に直接埋め込む |
| -n, --nodes | boolean | No | false | パーサーが生成するパースツリーを出力 |
| --nodejs [ARGS] | string | No | なし | nodeバイナリに直接オプションを渡す |
| --no-header | boolean | No | false | "Generated by"ヘッダーを抑制 |
| -o, --output [PATH] | string | No | カレントディレクトリ | コンパイル済みJavaScriptの出力パス |
| -p, --print | boolean | No | false | コンパイル済みJavaScriptを標準出力に出力 |
| -r, --require [MODULE*] | string[] | No | なし | eval/REPL前に指定モジュールをrequire |
| -s, --stdio | boolean | No | false | stdioでスクリプトを待ち受けてコンパイル |
| -t, --transpile | boolean | No | false | 生成JavaScriptをBabelでトランスパイル |
| --tokens | boolean | No | false | レキサー/リライターが生成するトークンを出力 |
| -v, --version | boolean | No | false | バージョン番号を表示 |
| -w, --watch | boolean | No | false | スクリプトの変更を監視してコマンドを再実行 |
| path/to/script.coffee | string | No | なし | コンパイル/実行するCoffeeScriptファイルパス |
| [args] | string[] | No | なし | スクリプトに渡す引数 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| .coffeeファイル | CoffeeScript | 通常のCoffeeScriptソースファイル |
| .litcoffeeファイル | Literate CoffeeScript | Markdown形式のCoffeeScriptファイル |
| .coffee.mdファイル | Literate CoffeeScript | Markdown拡張子のCoffeeScriptファイル |
| 標準入力 | CoffeeScript | --stdioオプション使用時 |
| コマンドライン文字列 | CoffeeScript | --evalオプション使用時 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| .jsファイル | JavaScript | コンパイル済みJavaScriptコード |
| .js.mapファイル | JSON | ソースマップファイル |
| 標準出力 | テキスト | --printオプション時のJavaScriptコード |
| 標準出力 | テキスト | --tokensオプション時のトークン列 |
| 標準出力 | テキスト | --nodesオプション時のパースツリー |
| 標準出力 | JSON | --astオプション時の抽象構文木 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 元ファイル名の拡張子を.jsに変更（例: script.coffee → script.js） |
| 出力先 | --outputオプションで指定されたパス、または元ファイルと同じディレクトリ |
| 文字コード | UTF-8 |
| 区切り文字 | なし |

## 処理フロー

### 処理シーケンス

```
1. エントリポイント（bin/coffee）
   └─ Node.jsランタイムのES6サポートを確認
2. CoffeeScriptモジュールの検索とロード
   └─ node_modules/coffeescript/lib/coffeescriptまたはローカルlibディレクトリを検索
3. command.run()の実行
   └─ コマンドライン引数のパース
4. オプションに応じた処理分岐
   └─ --help, --version, --interactive, --stdio, --eval等の判定
5. 入力ファイルの読み込み
   └─ ファイルシステムからソースコードを取得
6. コンパイル処理
   └─ トークン化 → リライト → パース → コード生成
7. 出力処理
   └─ ファイル保存、標準出力、または直接実行
8. 監視処理（--watch時）
   └─ fs.watchでファイル変更を監視し、変更時にリコンパイル
```

### フローチャート

```mermaid
flowchart TD
    A[bin/coffee実行] --> B{ES6サポート確認}
    B -->|失敗| C[エラー出力して終了]
    B -->|成功| D[CoffeeScriptモジュール検索]
    D --> E[command.run呼び出し]
    E --> F[引数パース]
    F --> G{オプション判定}
    G -->|--help| H[ヘルプ表示]
    G -->|--version| I[バージョン表示]
    G -->|--interactive| J[REPL起動]
    G -->|--stdio| K[標準入力からコンパイル]
    G -->|--eval| L[引数文字列をコンパイル]
    G -->|ファイル指定| M[ファイルコンパイル]
    M --> N{--watch?}
    N -->|Yes| O[ファイル監視開始]
    N -->|No| P[コンパイル完了]
    O --> Q[変更検知時リコンパイル]
    Q --> O
```

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

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

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

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | ランタイムエラー | Node.js 6未満で実行 | Node.js 6以上をインストール |
| 1 | ファイルエラー | ENOENT - 指定ファイルが存在しない | ファイルパスを確認 |
| 1 | パースエラー | オプション解析失敗 | オプション構文を確認 |
| 1 | コンパイルエラー | CoffeeScript構文エラー | ソースコードを修正 |
| 1 | Babelエラー | --transpile使用時にBabelがインストールされていない | npm install @babel/core |

### リトライ仕様

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

### 障害時対応

- コンパイルエラー発生時：エラーメッセージとスタックトレースを標準エラー出力に表示
- --watchモード時：エラーを表示後、監視を継続（ビープ音で通知）
- 致命的エラー時：process.exit(1)で終了

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回の実行で1〜数百ファイル |
| 目標処理時間 | 通常数秒以内 |
| メモリ使用量上限 | Node.jsデフォルト制限に従う |

## 排他制御

- 同時実行可能
- ファイル書き込み時の排他制御はNode.jsのfs.writeFileに依存
- --watchモード時は同一ファイルへの複数監視を防止

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| コンパイルログ | --watch時のコンパイル完了 | タイムスタンプとコンパイル対象ファイル |
| エラーログ | コンパイルエラー発生時 | エラーメッセージとスタックトレース |
| 削除ログ | --watch時のファイル削除検知 | 削除されたファイルパス |

## 監視・アラート

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

## 備考

- `coffee` コマンドは、引数なしで実行するとREPLモードで起動します
- `--join` オプションは非推奨であり、将来のバージョンで削除予定です
- ブラウザ環境向けのコンパイラは別途 `build:browser` タスクで生成されます
- Node.js 6以上が必要です（ES6の分割代入構文を使用しているため）
