# 通知設計書 2-バージョン不一致エラー

## 概要

本ドキュメントは、Tailwind CSS upgradeコマンド（`@tailwindcss/upgrade`）実行時に、package.jsonで期待されるTailwind CSSバージョンとnode_modulesにインストールされたバージョンが一致しない場合に出力されるエラーメッセージの通知仕様を定義する。

### 本通知の処理概要

upgradeコマンド実行時にインストール済みのTailwind CSSバージョンとpackage.jsonで期待されるバージョンを比較し、不一致の場合にdiff形式でエラーメッセージを表示してプロセスを終了する通知処理である。

**業務上の目的・背景**：Tailwind CSSのアップグレードツールは、インストール済みのバージョンに基づいてマイグレーション処理を行う。package.jsonの指定バージョンとnode_modulesの実際のバージョンが異なると、意図しないマイグレーション結果となる可能性がある。本エラー通知により、パッケージマネージャの`install`コマンド実行を促し、依存関係の整合性を確保した上でのアップグレードを保証する。

**通知の送信タイミング**：upgradeコマンド実行後、Gitチェック通過後かつアップグレード処理本体の開始前に送信される。具体的には `run()` 関数内の行66で `installedTailwindVersion(base) !== expectedTailwindVersion(base)` の比較が行われた直後に発生する。

**通知の受信者**：CLIを実行した開発者。標準エラー出力（stderr）に出力される。

**通知内容の概要**：diff形式で期待バージョン（package.json）とインストール済みバージョン（node_modules）を表示し、パッケージマネージャの`install`コマンドを実行するよう案内する。

**期待されるアクション**：開発者は表示されたパッケージマネージャのinstallコマンド（`npm install`、`pnpm install`、`yarn install`、`bun install`など）を実行してバージョンを同期させた後、再度upgradeコマンドを実行する。

## 通知種別

CLI標準エラー出力（stderr）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（プロセス内直接出力） |
| 優先度 | 高（プロセス終了を伴う） |
| リトライ | 無し（即時出力） |

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

CLIを実行したプロセスの標準エラー出力（`process.stderr`）に対して `eprintln()` 関数経由で出力する。

## 通知テンプレート

### メール通知の場合

該当なし（CLI出力のみ）

### 本文テンプレート

```
│ ↳ Version mismatch
│ ↳
│ ↳ ```diff
│ ↳ - "tailwindcss": "{expectedVersion}" (expected version in `package.json`)
│ ↳ + "tailwindcss": "{installedVersion}" (installed version in `node_modules`)
│ ↳ ```
│ ↳
│ ↳ Make sure to run `{pkgManager} install` and try again.
```

※ 先頭の `│` は `error()` 関数による赤色のパイプ文字装飾。diff内の `-` 行は赤色、`+` 行は緑色、バージョン番号は青色で装飾される。

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| expectedVersion | package.jsonで期待されるバージョン | `version.expectedTailwindVersion(base)` | Yes |
| installedVersion | node_modulesにインストールされたバージョン | `version.installedTailwindVersion(base)` | Yes |
| pkgManager | パッケージマネージャ名 | `pkg(base).manager()` | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| CLI操作 | `npx @tailwindcss/upgrade` 実行 | `installedTailwindVersion(base) !== expectedTailwindVersion(base)` | インストール済みバージョンとpackage.json期待バージョンが一致しない場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| バージョン一致時 | `installedTailwindVersion` と `expectedTailwindVersion` が同じ文字列の場合、エラーは発生しない |
| npm ls 失敗時 | `expectedTailwindVersion()` が `npm ls tailwindcss --json` の実行に失敗した場合、`installedTailwindVersion` にフォールバックするため不一致は発生しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[upgradeコマンド実行] --> B[Gitチェック通過]
    B --> C[installedTailwindVersion取得]
    C --> D[expectedTailwindVersion取得]
    D --> E{バージョン一致?}
    E -->|一致| F[アップグレード処理続行]
    E -->|不一致| G[パッケージマネージャ検出]
    G --> H[diff形式エラーメッセージ出力]
    H --> I[process.exit 1]
```

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

### 参照テーブル一覧

該当なし（データベースを使用しない）

### 更新テーブル一覧

該当なし（データベースを使用しない）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| Tailwind CSS未インストール | `getPackageVersionSync` でバージョンが取得できない | `installedTailwindVersion()` 内でエラーがスローされる |
| npm ls 実行失敗 | `npm ls tailwindcss --json` コマンドが失敗 | `expectedTailwindVersion()` がフォールバックで `installedTailwindVersion()` を返す |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（CLI実行時に即時出力）

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

本通知はバージョン番号とパッケージマネージャ名のみを出力する。ファイルシステムのパス情報（package.json、node_modules）は固定文字列として参照されるのみで、実際のパスは出力されない。

## 備考

- `expectedTailwindVersion()` は内部で `npm ls tailwindcss --json` を実行して期待バージョンを取得する。BunやPNPMでもこのコマンドは機能する
- バージョン情報は `DefaultMap` によりキャッシュされ、同一プロセス内での重複取得を防止している
- diff形式の出力は `picocolors` ライブラリにより赤/緑/青の色付けが行われる
- このチェックはGitディレクトリチェック（No.1）の直後、バージョン情報表示（No.4）の後に実行される

---

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

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

### 推奨読解順序

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

バージョン情報の取得と比較に関わるデータ構造を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | version.ts | `packages/@tailwindcss-upgrade/src/utils/version.ts` | `installedTailwindVersion()` と `expectedTailwindVersion()` の2つの関数がどのようにバージョンを取得するかを理解する。DefaultMapによるキャッシュ機構にも注目 |

**読解のコツ**: `DefaultMap` はキーに対する初回アクセス時にファクトリ関数を実行し、結果をキャッシュするMap拡張である。`cache` と `expectedCache` がそれぞれバージョン情報をキャッシュしている。

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

バージョン不一致チェックの呼び出し箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | index.ts | `packages/@tailwindcss-upgrade/src/index.ts` | 行66-85でバージョン不一致チェックとエラーメッセージ構築が行われる流れを理解する |

**主要処理フロー**:
1. **行62**: `info()` でアップグレード元バージョンを表示
2. **行66**: `installedTailwindVersion(base) !== expectedTailwindVersion(base)` で比較
3. **行67**: `pkg(base).manager()` でパッケージマネージャを検出
4. **行69-83**: `error()` でdiff形式のメッセージを構築・出力
5. **行84**: `process.exit(1)` でプロセスを終了

#### Step 3: パッケージマネージャ検出を理解する

パッケージマネージャの検出ロジックを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | packages.ts | `packages/@tailwindcss-upgrade/src/utils/packages.ts` | `pkg(base).manager()` がどのようにパッケージマネージャを検出するかを理解する |

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

```
index.ts :: run()
    │
    ├─ version.ts :: installedTailwindVersion(base)
    │      └─ getPackageVersionSync('tailwindcss', base)
    │
    ├─ version.ts :: expectedTailwindVersion(base)
    │      └─ execSync('npm ls tailwindcss --json')
    │
    ├─ packages.ts :: pkg(base).manager()
    │
    └─ renderer.ts :: error()
           └─ log() → eprintln() → process.stderr.write()
```

### データフロー図

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

node_modules ──────▶ installedTailwindVersion()
                           │
package.json ──────▶ expectedTailwindVersion() ──▶ バージョン比較
                           │                           │
                           │                     不一致の場合
                           │                           │
パッケージマネージャ ──▶ pkg().manager() ─────────▶ error() → stderr
                                                       │
                                                 process.exit(1)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| index.ts | `packages/@tailwindcss-upgrade/src/index.ts` | ソース | upgradeコマンドのエントリーポイント。行66-85でバージョン不一致チェックを実行 |
| version.ts | `packages/@tailwindcss-upgrade/src/utils/version.ts` | ソース | `installedTailwindVersion()` と `expectedTailwindVersion()` を提供 |
| renderer.ts | `packages/@tailwindcss-upgrade/src/utils/renderer.ts` | ソース | `error()`, `highlight()`, `eprintln()` 等のCLI出力ユーティリティ |
| packages.ts | `packages/@tailwindcss-upgrade/src/utils/packages.ts` | ソース | パッケージマネージャの検出機能を提供 |
