# 通知設計書 28-double-dash deprecation

## 概要

本ドキュメントは、CoffeeScript CLIにおける`--`引数の非推奨警告（double-dash deprecation）の通知仕様を記述する。

### 本通知の処理概要

本通知は、`coffee`コマンドが第2位置引数として`--`（ダブルダッシュ）を受け取った場合に発生する非推奨警告メッセージである。

**業務上の目的・背景**：CoffeeScript 2.0以前では、`--`を使用してコンパイラオプションとスクリプト引数を区切ることが一般的であった。しかし、引数解析の仕様が変更され、この使用方法は非推奨となった。この警告を表示することで、開発者に新しい引数指定方法への移行を促し、将来のバージョンでの互換性問題を回避する。

**通知の送信タイミング**：CLI実行時、オプション解析が完了した後、`opts.doubleDashed`フラグがfalseかつ`opts.arguments[1]`が`--`である場合に発生する。

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

**通知内容の概要**：警告メッセージとして「coffee was invoked with '--' as the second positional argument, which is now deprecated」が表示され、引数リストから`--`が自動的に削除される。

**期待されるアクション**：開発者は、スクリプトへの引数を渡す場合、スクリプトパスの前に`--`を配置する新しい方法に移行する必要がある。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

CLI実行時に標準エラー出力（stderr）に警告メッセージを出力する。処理は中断されず、`--`を引数リストから削除した上で続行される。

## 通知テンプレート

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

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

### 本文テンプレート

```
coffee was invoked with '--' as the second positional argument, which is
now deprecated. To pass '--' as an argument to a script to run, put an
additional '--' before the path to your script.

'--' will be removed from the argument list.
The positional arguments were: {argumentsList}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| argumentsList | 位置引数のJSON文字列 | opts.arguments | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| CLI実行 | オプション解析後 | !opts.doubleDashed && opts.arguments[1] === '--' | 第2位置引数が--でdoubleDashedフラグがfalse |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| doubleDashedフラグがtrue | オプション解析時に--が最初の位置引数として処理された場合 |
| 第2位置引数が--でない | 通常の引数指定の場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[CLI起動] --> B[オプション解析]
    B --> C{doubleDashed?}
    C -->|Yes| D[通常処理継続]
    C -->|No| E{arguments[1] === '--'?}
    E -->|No| D
    E -->|Yes| F[printWarn呼び出し]
    F --> G[警告メッセージ1出力]
    G --> H[printWarn呼び出し]
    H --> I[位置引数情報出力]
    I --> J[--を引数リストから削除]
    J --> D
    D --> K[コンパイル/実行処理]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 警告メッセージには引数リストが含まれる
- 機密情報が引数に含まれている場合、ログに残る可能性がある

## 備考

- この警告はCoffeeScript 2.0で導入された
- `--`は引数リストから自動的に削除されるため、スクリプトの動作には影響しない
- 将来のバージョンでは、この動作が削除される可能性がある

---

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

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

### 推奨読解順序

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

オプション解析結果の構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | optparse.coffee | `src/optparse.coffee` | doubleDashedフラグの設定（53-55行目） |

**読解のコツ**: `doubleDashed`フラグは、`--`がオプション解析中に最初の位置引数として検出された場合にtrueになる。

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

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

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

**主要処理フロー**:
1. **79行目**: 条件チェック`(not opts.doubleDashed) and (opts.arguments[1] is '--')`
2. **80-86行目**: printWarnで警告メッセージを出力
3. **87行目**: printWarnで位置引数情報を出力
4. **88行目**: `--`を引数リストから削除

#### Step 3: printWarn関数を理解する

警告出力関数の動作を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | command.coffee | `src/command.coffee` | printWarn関数の定義 |

**主要処理フロー**:
- stderrへの出力
- メッセージのフォーマット

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

```
coffee コマンド実行
    │
    ├─ parseOptions()
    │      └─ OptionParser.parse()
    │             └─ doubleDashedフラグ設定
    │
    └─ run()
           ├─ 条件チェック
           │      └─ !doubleDashed && arguments[1] === '--'
           │
           ├─ printWarn()
           │      └─ 警告メッセージ出力
           │
           ├─ printWarn()
           │      └─ 位置引数情報出力
           │
           └─ 引数リスト修正
                  └─ opts.arguments = [opts.arguments[0]].concat opts.arguments[2..]
```

### データフロー図

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

coffee script.coffee -- -a  条件チェック               警告メッセージ
                            │                         "coffee was invoked
                            ▼                          with '--' as the
arguments:              doubleDashed: false            second positional
  [0] = "script.coffee"  arguments[1] === '--'        argument..."
  [1] = "--"                   │
  [2] = "-a"                   ▼
                         printWarn(...)
                               │
                               ▼
                         引数リスト修正
                         arguments:
                           [0] = "script.coffee"
                           [1] = "-a"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| command.coffee | `src/command.coffee` | ソース | CLI処理、警告出力 |
| optparse.coffee | `src/optparse.coffee` | ソース | オプション解析、doubleDashedフラグ |
| invocation_argument_parsing.coffee | `test/invocation_argument_parsing.coffee` | テスト | テストケース（36行目） |
