# 通知設計書 70-WINDOW_MODIFY_REQUIRE_PATH

## 概要

本ドキュメントは、Lua Language Server における `WINDOW_MODIFY_REQUIRE_PATH` 通知の設計仕様を定義する。この通知は、ファイルがリネームまたは移動された際に、そのファイルを`require`している箇所のパスを自動的に更新するかどうかをユーザーに確認するためのダイアログメッセージとして使用される。

### 本通知の処理概要

**業務上の目的・背景**：Luaプロジェクトでは、`require`関数を使用してモジュールを読み込む。ファイルがリネームまたは移動されると、そのファイルを参照している`require`文のパスが古いままとなり、実行時エラーの原因となる。本通知は、ファイルのリネーム/移動操作が検出された際に、関連する`require`文のパスを自動更新するかどうかをユーザーに確認するために使用される。

**通知の送信タイミング**：LSPの`workspace/willRenameFiles`または`workspace/didRenameFiles`イベントでファイルのリネーム/移動が検出され、そのファイルを`require`している箇所が見つかった場合に送信される。

**通知の受信者**：IDEやエディタを使用している開発者（ユーザー）に対して、確認ダイアログとして表示される。

**通知内容の概要**：「requireのパスを変更しますか？」という確認メッセージ。

**期待されるアクション**：ユーザーは「変更」ボタンをクリックして自動更新を実行するか、ダイアログを閉じて手動で対応する。

## 通知種別

アプリ内通知（LSP window/showMessageRequest）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（ユーザー入力待ち） |
| 優先度 | 中（Info） |
| リトライ | 無 |

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

LSPプロトコルを通じて、接続中のクライアント（IDE/エディタ）に直接送信される。

## 通知テンプレート

### メール通知の場合

該当なし（LSP通知のみ）

### 本文テンプレート

英語:
```
Do you want to modify the require path?
```

日本語:
```
`require` のパスを変更しますか。
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | テンプレート変数は使用されない | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ファイル操作 | ファイルリネーム/移動 | 変更対象ファイルをrequireしている箇所が存在する場合 | modifyRequirePath関数で検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 変更箇所なし | requireしている箇所が見つからない場合は送信されない |
| リネームリストが空 | リネーム対象が空の場合は送信されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ファイルリネーム/移動イベント] --> B[modifyRequirePath呼び出し]
    B --> C{renamesが空?}
    C -->|Yes| D[終了]
    C -->|No| E[全ファイル走査]
    E --> F[checkConvert呼び出し]
    F --> G[requireの特殊パターン検出]
    G --> H{古いパスにマッチ?}
    H -->|No| I[次のファイルへ]
    H -->|Yes| J[新しいパスを取得]
    J --> K[changesに追加]
    I --> L{全ファイル処理完了?}
    K --> L
    L -->|No| E
    L -->|Yes| M{changesが空?}
    M -->|Yes| D
    M -->|No| N[client.awaitRequestMessage]
    N --> O[WINDOW_MODIFY_REQUIRE_PATH表示]
    O --> P{WINDOW_MODIFY_REQUIRE_OK選択?}
    P -->|No| D
    P -->|Yes| Q[client.editMultiText]
    Q --> D
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし（ファイル内のテキスト編集）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| パス解決失敗 | 新しいパスが解決できない場合 | その箇所はスキップ |
| ファイル編集失敗 | 編集リクエストが失敗した場合 | エラーログを出力 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（随時送信）

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

- ファイル内容の編集を伴う操作であり、ユーザーの明示的な確認を要する
- 編集はworkspace/applyEditを通じて行われ、IDEの管理下で実行される
- 自動編集の対象は`require`文の文字列リテラルのみに限定

## 備考

- `WINDOW_MODIFY_REQUIRE_OK`ボタンと組み合わせて表示される
- 複数ファイルの一括編集に対応（editMultiText使用）
- 新しいパスはrpath.getVisiblePathで解決される
- 文字列リテラルの引用符スタイル（シングル/ダブル）は維持される

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | modifyRequirePath.lua | `script/core/modifyRequirePath.lua` | renameとchangesの構造を理解する |

**読解のコツ**:
- `rename`は`{ oldUri, newUri }`の形式
- `changes`は`{ uri, start, finish, text }`の形式

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | modifyRequirePath.lua | `script/core/modifyRequirePath.lua` | メインの無名関数（54-74行目）がエントリーポイント |

**主要処理フロー**:
1. **55-57行**: renamesが空の場合は早期リターン
2. **58行**: changesを初期化
3. **59-62行**: 全ファイルを走査してcheckConvertを呼び出し
4. **63-65行**: changesが空の場合は早期リターン
5. **67-68行**: ユーザー確認ダイアログを表示

#### Step 3: パス変換ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | modifyRequirePath.lua | `script/core/modifyRequirePath.lua` | checkConvert関数（15-50行目）でrequire文の検出と変換を理解 |

**主要処理フロー**:
- **21行**: guide.eachSpecialOfで'require'パターンを検出
- **35行**: rpath.isMatchedUriで古いパスとのマッチングを確認
- **36行**: rpath.getVisiblePathで新しいパスを取得
- **39-45行**: changesに変更を追加

#### Step 4: 多言語対応を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | script.lua | `locale/en-us/script.lua` | 613-614行目で英語メッセージテンプレートを確認 |
| 4-2 | script.lua | `locale/ja-jp/script.lua` | 613-614行目で日本語メッセージテンプレートを確認 |

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

```
workspace/willRenameFiles (LSPハンドラ)
    |
    └─ modifyRequirePath (54行)
           |
           ├─ files.eachFile (59行)
           |      |
           |      └─ checkConvert (60行)
           |             |
           |             ├─ files.getState (16行)
           |             |
           |             ├─ guide.eachSpecialOf (21行)
           |             |      └─ 'require'検出
           |             |
           |             ├─ rpath.isMatchedUri (35行)
           |             |
           |             └─ rpath.getVisiblePath (36行)
           |
           ├─ client.awaitRequestMessage (67行)
           |      |
           |      ├─ WINDOW_MODIFY_REQUIRE_PATH
           |      |
           |      └─ WINDOW_MODIFY_REQUIRE_OK
           |
           └─ client.editMultiText (72行)
```

### データフロー図

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

ファイルリネーム     ───▶  modifyRequirePath        ───▶  (変更なし)
  ├ oldUri                |
  └ newUri                v
                    files.eachFile
                           |
                           v
                    checkConvert
                           |
                           v
                    guide.eachSpecialOf('require')
                           |
                           v
                    rpath.isMatchedUri ───▶ マッチ判定
                           |
                           v
                    rpath.getVisiblePath ───▶ 新パス取得
                           |
                           v
                    changes配列に追加
                           |
                           v
        WINDOW_MODIFY_REQUIRE_PATH表示 ───▶ ユーザー確認
                           |
                           v (OK選択)
                client.editMultiText ───▶ ファイル編集
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| modifyRequirePath.lua | `script/core/modifyRequirePath.lua` | ソース | requireパス変更ロジック |
| client.lua | `script/client.lua` | ソース | メッセージリクエスト送信と編集実行 |
| require-path.lua | `script/workspace/require-path.lua` | ソース | requireパス解決 |
| guide.lua | `script/parser/guide.lua` | ソース | AST走査（eachSpecialOf） |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージテンプレート |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージテンプレート |
