# 通知設計書 71-WINDOW_MODIFY_REQUIRE_OK

## 概要

本ドキュメントは、Lua Language Serverにおける `WINDOW_MODIFY_REQUIRE_OK` 通知の設計を記述する。この通知は、ファイルのリネーム操作後にrequireパスの変更を実行するためのボタンとして使用される。

### 本通知の処理概要

この通知は、ファイルリネーム時にrequireパスを自動的に更新するかどうかをユーザーに確認するダイアログで表示される「変更」ボタンのラベルを提供する。

**業務上の目的・背景**：Luaプロジェクトにおいて、ファイルの名前やパスが変更されると、そのファイルをrequireしている他のソースコード内のパス指定も更新が必要となる。この通知は、そのような変更を一括して行うための確認ダイアログのボタンラベルを提供することで、開発者の手動修正の手間を軽減し、リファクタリングの効率化を実現する。

**通知の送信タイミング**：ワークスペース内でファイルのリネーム操作（`workspace/didRenameFiles`イベント）が発生し、そのファイルがLuaファイルであり、かつ他のファイルからrequireされている場合に、確認ダイアログとともにこのボタンラベルが表示される。

**通知の受信者**：VSCode等のLSPクライアントを使用している開発者。ダイアログはエディタのUI上に表示される。

**通知内容の概要**：ボタンラベルとして「変更」（日本語）または「Modify」（英語）というテキストが表示される。

**期待されるアクション**：ユーザーがこのボタンをクリックすると、影響を受けるすべてのrequire文のパスが自動的に新しいファイルパスに更新される。

## 通知種別

アプリ内通知（LSPクライアント経由のメッセージボックス）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（awaitRequestMessage） |
| 優先度 | 中 |
| リトライ | なし |

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

LSPプロトコルを介してクライアント（VSCode等のエディタ）に対してメッセージリクエストとして送信される。受信者はエディタを操作中の開発者となる。

## 通知テンプレート

### メッセージボックスの場合

| 項目 | 内容 |
|-----|------|
| メッセージタイプ | Info |
| 本文 | WINDOW_MODIFY_REQUIRE_PATH（requireパス変更確認メッセージ） |
| ボタン1 | WINDOW_MODIFY_REQUIRE_OK（変更/Modify） |

### 本文テンプレート

```
日本語: `require` のパスを変更しますか。
英語: Do you want to modify the require path?
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | このボタンラベルは固定テキスト | locale/*/script.lua | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| LSPイベント | workspace/didRenameFiles | リネーム対象がLuaファイルであり、他ファイルからrequireされている | ファイルリネーム時にrequireパスの更新確認 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 変更対象なし | リネームされたファイルをrequireしているファイルが存在しない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[workspace/didRenameFiles発生] --> B[Luaファイル判定]
    B -->|Luaファイル| C[require参照チェック]
    B -->|非Luaファイル| D[終了]
    C -->|参照あり| E[変更箇所収集]
    C -->|参照なし| D
    E --> F[確認ダイアログ表示]
    F --> G{ユーザー選択}
    G -->|WINDOW_MODIFY_REQUIRE_OK| H[パス更新実行]
    G -->|キャンセル| D
    H --> I[テキスト編集適用]
    I --> D
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない。インメモリでファイル情報を管理する。

### テーブル別参照項目詳細

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 編集適用失敗 | クライアント側でテキスト編集が失敗 | エラーログ出力、ユーザーへの通知なし |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（エディタ操作時のみ）

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

- ファイルパス情報のみを扱うため、個人情報の取り扱いはない
- ソースコードの変更を伴うため、変更前にユーザー確認を必須とする

## 備考

- この通知は`WINDOW_MODIFY_REQUIRE_PATH`通知と組み合わせて使用される
- ボタンラベルはロケールに応じて多言語対応される

---

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

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

### 推奨読解順序

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

まず、通知で使用されるローカライズ文字列の定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | script.lua | `locale/ja-jp/script.lua` | WINDOW_MODIFY_REQUIRE_OKの日本語定義（615-616行目）を確認 |
| 1-2 | script.lua | `locale/en-us/script.lua` | WINDOW_MODIFY_REQUIRE_OKの英語定義（615-616行目）を確認 |

**読解のコツ**: ロケールファイルは単純なキー=値形式で定義されている。

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

処理の起点となるファイル・関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | provider.lua | `script/provider/provider.lua` | workspace/didRenameFilesイベントハンドラ（190-244行目） |

**主要処理フロー**:
1. **190-213行目**: ファイルリネームイベントの登録とcapability定義
2. **214-244行目**: リネーム処理の実装、modifyRequirePathの呼び出し

#### Step 3: コア処理を理解する

requireパス変更の本体処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | modifyRequirePath.lua | `script/core/modifyRequirePath.lua` | requireパス変更のメイン処理 |

**主要処理フロー**:
- **15-50行目**: checkConvert関数でrequire文の検索と変更箇所の収集
- **54-74行目**: メイン関数でダイアログ表示とユーザー選択の処理
- **67-68行目**: WINDOW_MODIFY_REQUIRE_PATHとWINDOW_MODIFY_REQUIRE_OKの使用箇所

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

```
workspace/didRenameFiles (provider.lua:214)
    │
    └─ require('core.modifyRequirePath') (provider.lua:241)
           │
           ├─ checkConvert() (modifyRequirePath.lua:15)
           │      └─ guide.eachSpecialOf() - require文の検索
           │
           └─ client.awaitRequestMessage() (modifyRequirePath.lua:67)
                  │
                  ├─ lang.script.WINDOW_MODIFY_REQUIRE_PATH - メッセージ本文
                  └─ lang.script.WINDOW_MODIFY_REQUIRE_OK - ボタンラベル
```

### データフロー図

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

ファイルリネーム ───▶ require参照検索 ───▶ 確認ダイアログ表示
イベント               │                   │
                       │                   ├─▶ ユーザーがOK
                       │                   │   └─▶ テキスト編集適用
                       │                   │
                       └─▶ 変更箇所リスト   └─▶ キャンセル
                                               └─▶ 何もしない
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| modifyRequirePath.lua | `script/core/modifyRequirePath.lua` | ソース | requireパス変更のコア処理 |
| provider.lua | `script/provider/provider.lua` | ソース | LSPイベントハンドラ |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージ定義 |
| client.lua | `script/client.lua` | ソース | クライアント通信処理 |
