# 通知設計書 23-normalized argv

## 概要

正規化されたコマンドライン引数をデバッグ出力する通知の設計書です。

### 本通知の処理概要

本通知は、Prettierの内部でコマンドライン引数が正規化（パース・変換）された後の状態をJSON形式でデバッグ出力するものです。開発者がPrettierの引数解析の動作を確認したい場合や、問題のトラブルシューティングを行う際に使用されます。

**業務上の目的・背景**：Prettierは多数のコマンドラインオプションをサポートしており、エイリアス、デフォルト値、型変換など複雑な処理が行われます。開発者がPrettierの動作を調査する際、実際にどのような引数値がアプリケーション内部で使用されているかを確認することは、問題解決において非常に重要です。この通知により、引数の正規化結果を可視化し、設定の問題を特定しやすくします。

**通知の送信タイミング**：CLIのmain関数の冒頭で、コンテキストの初期化が完了し`context.argv`が設定された直後に出力されます。具体的には、`index.js`のmain関数の最初の行で実行されます。

**通知の受信者**：CLIを実行している開発者（標準エラー出力経由、`--log-level debug`指定時のみ）。

**通知内容の概要**：デバッグメッセージは `normalized argv: {JSON形式の引数オブジェクト}` という形式で出力されます。すべての正規化された引数がJSON.stringifyで文字列化されて表示されます。

**期待されるアクション**：開発者は出力されたJSON内容を確認し、期待する引数値が正しく設定されているかを検証します。問題がある場合は、コマンドライン引数や設定ファイルを修正します。

## 通知種別

CLIデバッグ出力（stderr）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 低（デバッグ情報） |
| リトライ | 無 |

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

`logger.debug`メソッドを使用して出力されます。このメソッドは`--log-level debug`が指定されている場合のみ出力を行います。

## 通知テンプレート

### CLI出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr |
| プレフィックス | `[debug]`（青色） |
| 形式 | テキスト（JSON含む） |

### 本文テンプレート

```
[debug] normalized argv: {"_":[],"check":false,"write":false,...}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| argv | 正規化されたコマンドライン引数オブジェクト | context.argv | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| CLI実行 | main関数開始時 | `--log-level debug`が指定されている | コンテキスト初期化完了後 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `--log-level`がdebug以外 | デフォルト(log)や他のレベルでは出力されない |
| `--log-level silent` | 全てのログ出力が抑制される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[CLI実行開始] --> B[logLevelパース]
    B --> C{logLevel == debug?}
    C -->|Yes| D[debugロガー有効化]
    C -->|No| E[debugロガー無効化]
    D --> F[Context初期化]
    E --> F
    F --> G[parseArgv実行]
    G --> H[context.argv設定]
    H --> I[main関数開始]
    I --> J{debugロガー有効?}
    J -->|Yes| K[logger.debug出力]
    K --> L[normalized argv表示]
    J -->|No| M[スキップ]
    L --> N[次の処理へ]
    M --> N
```

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

### 参照テーブル一覧

なし

### 更新テーブル一覧

なし

## エラー処理

### エラーケース一覧

なし（デバッグ出力のため）

### リトライ仕様

なし

## 配信設定

### レート制限

なし（CLI実行ごとに1回）

### 配信時間帯

制限なし

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

- 引数には機密情報（ファイルパスなど）が含まれる可能性がある
- デバッグレベルでのみ出力されるため、通常運用では露出しない
- CI/CD環境でログが保存される場合は注意が必要

## 備考

- `JSON.stringify(context.argv)`でオブジェクト全体が文字列化される
- context.argvには`_`プロパティ（位置引数のリスト）も含まれる
- パフォーマンステストフラグが有効な場合、logLevelがdebugに自動変更される

---

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

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

### 推奨読解順序

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

まず、argvオブジェクトの構造を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | context.js | `src/cli/context.js` | Contextクラスとargvプロパティの定義を確認 |
| 1-2 | cli-options.evaluate.js | `src/cli/cli-options.evaluate.js` | オプション定義でargvに含まれるキーを確認 |

**読解のコツ**: context.jsの7-18行目のJSDocでContextの型定義を確認し、39-40行目でargvの設定を確認する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | index.js | `src/cli/index.js` | run関数とmain関数の流れを確認 |

**主要処理フロー**:
1. **18-25行目**: logLevelの解析とロガーの作成
2. **26-27行目**: Contextの作成と初期化
3. **40行目**: `context.logger.debug(`normalized argv: ${JSON.stringify(context.argv)}`)`

#### Step 3: ロガーを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | logger.js | `src/cli/logger.js` | createLogger関数とdebugメソッドの実装 |

**主要処理フロー**:
- **21-28行目**: createLogger関数でlogLevelに応じたロガーを作成
- **26行目**: debugメソッドは青色でフォーマット
- **57-78行目**: shouldLog関数でlogLevelに応じた出力制御

#### Step 4: 引数パース処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | parse-cli-arguments.js | `src/cli/options/parse-cli-arguments.js` | parseArgv関数の実装 |

**主要処理フロー**:
- 引数のパースと正規化処理

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

```
src/cli/index.js::run()
    │
    ├─ parseArgvWithoutPlugins() - logLevelの取得
    │
    ├─ createLogger(logLevel) - ロガー作成
    │
    ├─ new Context() - コンテキスト作成
    │      │
    │      └─ context.init()
    │             │
    │             └─ parseArgv() - 引数パース
    │
    └─ main()
           │
           └─ context.logger.debug() - normalized argv出力
                  │
                  └─ logger.js::createLogFunc()
```

### データフロー図

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

process.argv ─────▶ parseArgv() ─────▶ context.argv
                         │
                         └─▶ JSON.stringify() ─────▶ [debug] normalized argv: {...}
                                                          │
                                                          └─▶ stderr
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| index.js | `src/cli/index.js` | ソース | CLIエントリーポイント、normalized argv出力 |
| context.js | `src/cli/context.js` | ソース | Contextクラス定義、argv管理 |
| logger.js | `src/cli/logger.js` | ソース | ログ出力機能 |
| parse-cli-arguments.js | `src/cli/options/parse-cli-arguments.js` | ソース | 引数パース処理 |
| cli-options.evaluate.js | `src/cli/cli-options.evaluate.js` | ソース | CLIオプション定義 |
