# 通知設計書 31-option parsing error

## 概要

本ドキュメントは、CoffeeScriptコンパイラのコマンドラインオプション解析時に発生するエラー通知「option parsing error」の設計仕様を記載する。

### 本通知の処理概要

CoffeeScriptのCLI（`coffee`コマンド）実行時に、コマンドライン引数の解析（オプションパース）処理で問題が発生した際に、エラーメッセージを標準エラー出力に表示し、プロセスを終了コード1で終了する通知機能である。

**業務上の目的・背景**：ユーザーがCLIを使用する際、誤ったオプションや不正な引数の組み合わせを指定した場合に、何が問題であるかを明確に伝える必要がある。これにより、ユーザーは正しいオプション指定方法を学習し、コマンドを修正できる。

**通知の送信タイミング**：`coffee`コマンドの起動直後、`process.argv`から取得した引数を`OptionParser.parse()`メソッドで解析する際に例外が発生した時点で即座に通知される。

**通知の受信者**：コマンドラインでCoffeeScriptコンパイラを実行している開発者またはビルドシステム。標準エラー出力（stderr）に出力されるため、ターミナルまたはログ収集システムが受信者となる。

**通知内容の概要**：「option parsing error: {具体的なエラーメッセージ}」の形式でエラー内容を出力する。エラーメッセージには「unrecognized option {フラグ}」「value required for {フラグ}」等の詳細情報が含まれる。

**期待されるアクション**：ユーザーはエラーメッセージを確認し、`coffee --help`でヘルプを参照するか、指定したオプションを修正してコマンドを再実行することが期待される。

## 通知種別

コンソール出力（標準エラー出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 高 |
| リトライ | 無し |

### 送信先決定ロジック

標準エラー出力（stderr）への直接出力のため、受信者決定ロジックは不要。コマンド実行元のターミナルまたはパイプ先に出力される。

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr（console.error） |
| 形式 | テキスト |

### 本文テンプレート

```
option parsing error: {message}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| message | エラー詳細メッセージ | 例外オブジェクト（err.message） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| CLI実行 | optionParser.parse()での例外発生 | 常に送信 | オプション解析中の例外をキャッチした場合 |

### エラー発生パターン

| エラー種別 | 発生条件 | エラーメッセージ例 |
|----------|---------|-----------------|
| unrecognized option | 未定義のオプションフラグを指定 | `unrecognized option --unknown` |
| value required | 引数が必要なオプションに値を指定せず最後の引数になった場合 | `value required for --output, but it was the last argument provided` |
| multi-flag error | マルチフラグ内で引数が必要なオプションを最後以外で指定 | `cannot use option -o in multi-flag -cow except as the last option` |
| duplicate flag | 同じフラグが複数のスイッチに定義された場合 | `flag --foo for switch bar was already declared for switch baz` |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | オプション解析エラーは常にユーザーに通知される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[coffee コマンド実行] --> B[parseOptions関数呼び出し]
    B --> C[optionParser.parse実行]
    C --> D{例外発生?}
    D -->|Yes| E[console.error でエラーメッセージ出力]
    E --> F[process.exit 1]
    D -->|No| G[正常処理継続]
```

## データベース参照・更新仕様

### 参照テーブル一覧

なし（ファイルシステムやデータベースは参照しない）

### 更新テーブル一覧

なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 解析エラー | 不正なオプション指定 | エラーメッセージを表示して終了 |

### リトライ仕様

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

## 配信設定

### レート制限

なし（コマンド実行ごとに1回のみ発生）

### 配信時間帯

制限なし

## セキュリティ考慮事項

- ユーザー入力（コマンドライン引数）がそのままエラーメッセージに含まれるため、ログ収集時に機密情報が含まれないことを確認する必要がある
- プロセス終了コード1により、シェルスクリプトやCI/CDパイプラインでエラー検知が可能

## 備考

- CoffeeScript 2.x系でサポートされている全オプションは`SWITCHES`配列で定義されている
- エラーメッセージはoptparse.coffee内の`normalizeArguments`関数および`buildRules`関数で生成される

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

オプション解析に使用されるルール定義の構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | command.coffee | `src/command.coffee` | SWITCHES配列（34-56行目）でオプション定義を確認 |
| 1-2 | optparse.coffee | `src/optparse.coffee` | buildRule関数（102-113行目）でルール構造を理解 |

**読解のコツ**: CoffeeScriptの配列リテラル記法に慣れること。`[short, long, description]`形式でオプションが定義されている。

#### Step 2: エントリーポイントを理解する

処理の起点となるrun関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | command.coffee | `src/command.coffee` | exports.run関数（72-139行目）がCLIのエントリーポイント |

**主要処理フロー**:
1. **72行目**: `exports.run`関数の定義開始
2. **73行目**: `optionParser`のインスタンス化
3. **74-77行目**: `parseOptions()`をtry-catchで囲みエラー捕捉
4. **76行目**: `console.error`でエラーメッセージを出力
5. **77行目**: `process.exit 1`で終了

#### Step 3: オプション解析処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | optparse.coffee | `src/optparse.coffee` | OptionParser.parse（30-58行目）でメイン解析ロジックを確認 |
| 3-2 | optparse.coffee | `src/optparse.coffee` | normalizeArguments（115-165行目）でエラー発生箇所を特定 |

**主要処理フロー**:
- **136行目**: 未認識オプションで`throw new Error "unrecognized option"`
- **142-143行目**: マルチフラグ内での引数オプション位置エラー
- **152行目**: 単独オプションの未認識エラー
- **163-164行目**: 引数不足エラー

### プログラム呼び出し階層図

```
exports.run (command.coffee:72)
    │
    ├─ buildCSOptionParser (command.coffee:66-67)
    │      └─ new OptionParser (optparse.coffee:14)
    │             └─ buildRules (optparse.coffee:85-98)
    │
    └─ parseOptions (command.coffee:445-449)
           └─ optionParser.parse (optparse.coffee:30-58)
                  └─ normalizeArguments (optparse.coffee:115-165)
                         └─ throw Error [エラー発生箇所]
```

### データフロー図

```
[入力]                      [処理]                           [出力]

process.argv ───▶ OptionParser.parse() ───▶ console.error()
                         │                         │
                         ▼                         ▼
                  normalizeArguments()        process.exit(1)
                         │
                         ▼
                  throw Error (エラー時)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| command.coffee | `src/command.coffee` | ソース | CLIエントリーポイント、エラー出力処理 |
| optparse.coffee | `src/optparse.coffee` | ソース | オプション解析、エラー生成 |
| helpers.coffee | `src/helpers.coffee` | ソース | ユーティリティ関数（repeat等） |
