# 通知設計書 29-join option deprecation

## 概要

本ドキュメントは、CoffeeScript CLIにおける`--join`オプションの非推奨警告（join option deprecation）の通知仕様を記述する。

### 本通知の処理概要

本通知は、`coffee`コマンドで`--join`（または`-j`）オプションが使用された場合に発生する非推奨警告メッセージである。

**業務上の目的・背景**：`--join`オプションは、複数のCoffeeScriptソースファイルをコンパイル前に結合する機能を提供していた。しかし、この機能は問題を引き起こす可能性があり（例：スコープの共有、依存関係の管理困難）、より標準的なモジュールシステム（ES modules, CommonJS）の使用が推奨されている。このオプションを非推奨とし、代替手段を提示することで、より保守性の高いコード構造への移行を促す。

**通知の送信タイミング**：CLI実行時、オプション解析後に`opts.join`が指定されている場合、コンパイル処理開始前に発生する。

**通知の受信者**：CoffeeScript CLIを実行しているユーザー。標準エラー出力に警告メッセージが出力される。

**通知内容の概要**：警告メッセージとして「The --join option is deprecated and will be removed in a future version」が表示され、`cat`コマンドと`--stdio`オプションを使用した代替方法が提示される。

**期待されるアクション**：開発者は、`--join`オプションの使用を中止し、`cat file1.coffee file2.coffee | coffee --compile --stdio > bundle.js`のような代替方法に移行するか、モジュールシステムを使用する必要がある。

## 通知種別

コンソール警告出力（stderr）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（CLI処理中に即時出力） |
| 優先度 | 中（警告、処理は継続） |
| リトライ | なし |

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

CLI実行時に標準エラー出力（stderr）に警告メッセージを出力する。処理は中断されず、`--join`オプションの機能は引き続き実行される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr |
| 形式 | テキスト |

### 本文テンプレート

```

The --join option is deprecated and will be removed in a future version.

If for some reason it's necessary to share local variables between files,
replace...

    $ coffee --compile --join bundle.js -- a.coffee b.coffee c.coffee

with...

    $ cat a.coffee b.coffee c.coffee | coffee --compile --stdio > bundle.js

```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | 固定メッセージ | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| CLI実行 | オプション解析後 | opts.join が指定されている | --joinまたは-jオプションが使用された場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --joinオプション未指定 | オプションが指定されていない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[CLI起動] --> B[オプション解析]
    B --> C{opts.join指定あり?}
    C -->|No| D[通常処理継続]
    C -->|Yes| E[path.resolve処理]
    E --> F[console.error呼び出し]
    F --> G[非推奨警告メッセージ出力]
    G --> H[コンパイル処理継続]
    H --> I[ファイル結合・コンパイル]
    D --> J[通常コンパイル処理]
```

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

### 参照テーブル一覧

該当なし（CLIオプション処理）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | 警告のみ、エラーは発生しない | - |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | N/A（警告のみ） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | なし（CLI実行ごとに1回） |

### 配信時間帯

制限なし（CLI実行時に即時通知）

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

- 警告メッセージには機密情報は含まれない
- 固定のガイダンスメッセージのみ出力

## 備考

- この警告はCoffeeScript 1.8.0で導入された
- `--join`オプション自体は引き続き動作するが、将来のバージョンで削除される予定
- 代替として`cat ... | coffee --stdio`の使用が推奨される

---

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

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

### 推奨読解順序

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

オプション定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | command.coffee | `src/command.coffee` | SWITCHESでの-j/--join定義（41行目） |

**読解のコツ**: SWITCHESはオプション定義の配列で、短縮形、長形式、説明を含む。

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

警告処理のエントリーポイントを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | command.coffee | `src/command.coffee` | 121-134行目 - join非推奨警告 |

**主要処理フロー**:
1. **121行目**: `if opts.join`でjoinオプションの存在をチェック
2. **122行目**: `path.resolve opts.join`でパスを絶対パスに変換
3. **123-134行目**: `console.error`で非推奨警告メッセージを出力

#### Step 3: 代替方法を理解する

警告メッセージで提示される代替方法を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | command.coffee | `src/command.coffee` | 130-134行目 - 代替コマンド例 |

**主要処理フロー**:
- **130行目**: 旧コマンド例 `coffee --compile --join bundle.js -- a.coffee b.coffee c.coffee`
- **134行目**: 新コマンド例 `cat a.coffee b.coffee c.coffee | coffee --compile --stdio > bundle.js`

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

```
coffee --join bundle.js -- a.coffee b.coffee
    │
    ├─ parseOptions()
    │      └─ opts.join = "bundle.js"
    │
    └─ run()
           ├─ if opts.join
           │      ├─ path.resolve(opts.join)
           │      └─ console.error(警告メッセージ)
           │
           └─ compileJoin()
                  └─ ファイル結合・コンパイル処理
```

### データフロー図

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

coffee --join bundle.js      オプション解析               警告メッセージ
    a.coffee b.coffee             │                      "The --join option
                                  ▼                       is deprecated..."
                          opts.join = "bundle.js"              │
                                  │                            ▼
                                  ▼                       標準エラー出力
                          path.resolve()
                                  │
                                  ▼
                          console.error()
                                  │
                                  ▼
                          compileJoin()
                                  │
                                  ▼
                          bundle.js生成
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| command.coffee | `src/command.coffee` | ソース | CLI処理、警告出力、joinオプション定義 |
| argument_parsing.coffee | `test/argument_parsing.coffee` | テスト | オプション解析テスト（128行目） |
| changelog/1.8.0.md | `documentation/sections/changelog/1.8.0.md` | ドキュメント | 非推奨の告知 |
