# 通知設計書 74-COMPLETION_ASK_AUTO_REQUIRE

## 概要

本ドキュメントは、Lua Language Serverにおける `COMPLETION_ASK_AUTO_REQUIRE` 通知の設計を記述する。この通知は、ファイル先頭にrequireコードを追加するかどうかを確認するダイアログのメッセージとして使用される。

### 本通知の処理概要

この通知は、コード補完で選択されたモジュールを自動的にrequireするかどうかをユーザーに確認するダイアログのメイン本文として表示される。

**業務上の目的・背景**：Luaでは外部モジュールを使用する際にrequire文を記述する必要がある。自動require機能はコード補完と連携し、モジュールの使用時に自動的にrequire文を挿入する。しかし、すべてのケースでrequireが必要とは限らないため、ユーザーに確認を求めることで、誤ったインポートを防止する。

**通知の送信タイミング**：自動requireコマンド（`lua.autoRequire`）が実行された際に、require文を追加するかどうかの確認ダイアログとして表示される。

**通知の受信者**：VSCode等のLSPクライアントを使用している開発者。

**通知内容の概要**：「ファイル先頭にこのファイルをrequireするコードを追加しますか？」（日本語）というメッセージ。

**期待されるアクション**：ユーザーは以下の選択肢から選択する：
1. 特定のrequireパスを選択してrequire文を追加
2. 自動require機能を無効化
3. ダイアログを閉じてキャンセル

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| メッセージタイプ | Info |
| 本文 | COMPLETION_ASK_AUTO_REQUIRE |
| 選択肢 | 動的に生成されるrequireパス + COMPLETION_DISABLE_AUTO_REQUIRE |

### 本文テンプレート

```
日本語: ファイル先頭にこのファイルを require するコードを追加しますか？
英語: Add the code at the top of the file to require this file?
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | このメッセージは固定テキスト | locale/*/script.lua | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コマンド実行 | lua.autoRequire | autoRequire設定がtrue | コード補完からの自動require要求 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| autoRequire無効 | Lua.completion.autoRequire設定がfalseの場合 |
| 既にrequire済み | 対象ファイルが既にrequireされている場合 |
| 可視パスなし | 対象ファイルへの有効なrequireパスが存在しない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[lua.autoRequireコマンド実行] --> B[ファイル状態確認]
    B --> C[visiblePathsの取得]
    C -->|パスあり| D[askAutoRequire呼び出し]
    C -->|パスなし| E[終了]
    D --> F[選択肢リスト生成]
    F --> G[awaitRequestMessage表示]
    G --> H{ユーザー選択}
    H -->|パス選択| I[require文挿入]
    H -->|disable| J[設定変更]
    H -->|キャンセル| E
    I --> K[applyAutoRequire呼び出し]
    K --> E
    J --> E
```

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

### 参照テーブル一覧

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

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

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- ソースコードの変更を伴うため、ユーザー確認を必須とする
- 信頼できるワークスペース内のファイルのみがrequire対象となる

## 備考

- このダイアログには動的に生成されるrequireパスの選択肢が含まれる
- require文の挿入位置は、既存のrequire文の後または最初の非コメント行

---

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

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

### 推奨読解順序

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

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

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

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

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | autoRequire.lua | `script/core/command/autoRequire.lua` | メイン処理（133-164行目） |

**主要処理フロー**:
1. **139-140行目**: ファイル状態の確認
2. **144-148行目**: visiblePathsの取得とソート
3. **153-157行目**: askAutoRequireの呼び出し条件

#### Step 3: ダイアログ表示処理を理解する

確認ダイアログの表示処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | autoRequire.lua | `script/core/command/autoRequire.lua` | askAutoRequire関数（69-102行目） |

**主要処理フロー**:
- **70-79行目**: 選択肢リストの生成（requireパス）
- **80-81行目**: COMPLETION_DISABLE_AUTO_REQUIREの追加
- **83-86行目**: COMPLETION_ASK_AUTO_REQUIREをメッセージとしてダイアログ表示
- **87-101行目**: ユーザー選択に応じた処理分岐

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

```
workspace/executeCommand (provider.lua:1008)
    │
    └─ require('core.command.autoRequire') (provider.lua:1009)
           │
           └─ autoRequire(data) (autoRequire.lua:133)
                  │
                  ├─ files.getState()
                  │
                  ├─ rpath.getVisiblePath()
                  │
                  └─ askAutoRequire() (autoRequire.lua:69)
                         │
                         ├─ lang.script.COMPLETION_ASK_AUTO_REQUIRE - 本文
                         │
                         ├─ lang.script.COMPLETION_DISABLE_AUTO_REQUIRE - 選択肢
                         │
                         └─ client.awaitRequestMessage()
```

### データフロー図

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

補完選択 ───▶ lua.autoRequire ───▶ visiblePaths取得
                    │                    │
                    │                    └─▶ 選択肢リスト生成
                    │
                    └─▶ askAutoRequire() ───▶ ダイアログ表示
                               │                    │
                               │                    └─▶ ユーザー選択
                               │
                               └─▶ applyAutoRequire() ───▶ require文挿入
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| autoRequire.lua | `script/core/command/autoRequire.lua` | ソース | 自動requireコマンド処理 |
| provider.lua | `script/provider/provider.lua` | ソース | LSPコマンドハンドラ |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージ定義 |
| require-path.lua | `script/workspace/require-path.lua` | ソース | requireパス解決 |
| client.lua | `script/client.lua` | ソース | クライアント通信処理 |
