# 通知設計書 73-COMPLETION_DISABLE_AUTO_REQUIRE

## 概要

本ドキュメントは、Lua Language Serverにおける `COMPLETION_DISABLE_AUTO_REQUIRE` 通知の設計を記述する。この通知は、自動require機能を無効化するためのオプションボタンとして使用される。

### 本通知の処理概要

この通知は、自動require確認ダイアログにおいて、「今後自動requireを無効にする」という選択肢のボタンラベルとして表示される。

**業務上の目的・背景**：Luaプロジェクトでは、他のファイルで定義されたモジュールを使用する際にrequire文を記述する必要がある。自動require機能はこれを自動化するが、プロジェクトの方針やコーディングスタイルによっては、この機能を望まない開発者もいる。この通知により、ユーザーは自動require機能を永続的に無効化できる。

**通知の送信タイミング**：自動require確認ダイアログ（COMPLETION_ASK_AUTO_REQUIRE）が表示される際に、選択肢の一つとしてこのボタンラベルが表示される。

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

**通知内容の概要**：「自動requireを無効にする」（日本語）または「Disable auto require」（英語）というボタンラベル。

**期待されるアクション**：ユーザーがこのボタンをクリックすると、`Lua.completion.autoRequire` 設定がfalseに変更され、以降の自動require機能が無効化される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| メッセージタイプ | Info |
| 本文 | COMPLETION_ASK_AUTO_REQUIRE（自動require確認メッセージ） |
| 選択肢の一つ | COMPLETION_DISABLE_AUTO_REQUIRE |

### 本文テンプレート

```
日本語: 自動 require を無効にします
英語: Disable auto require
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コマンド実行 | lua.autoRequire | 自動requireコマンド実行時 | require文の自動挿入確認 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| autoRequire既に無効 | 既に自動require機能が無効化されている場合（ダイアログ自体が表示されない） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[lua.autoRequireコマンド実行] --> B[askAutoRequire呼び出し]
    B --> C[選択肢リスト生成]
    C --> D[COMPLETION_DISABLE_AUTO_REQUIREを追加]
    D --> E[awaitRequestMessage表示]
    E --> F{ユーザー選択}
    F -->|disable選択| G[client.setConfig呼び出し]
    G --> H[Lua.completion.autoRequire=false設定]
    H --> I[終了]
    F -->|その他| I
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない。

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

該当なし

### 更新テーブル一覧

該当なし（設定ファイルの更新のみ）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 設定更新失敗 | クライアントが設定変更をサポートしていない | ユーザーに手動設定を促すメッセージを表示 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 設定変更のみを行うため、セキュリティリスクは低い
- ユーザーの明示的な操作によってのみ設定が変更される

## 備考

- この通知は`COMPLETION_ASK_AUTO_REQUIRE`と組み合わせて使用される
- 設定変更後は再起動不要で即座に反映される

---

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

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

### 推奨読解順序

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

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

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

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

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

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

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

**主要処理フロー**:
1. **69-79行目**: 選択肢リストの生成
2. **80行目**: COMPLETION_DISABLE_AUTO_REQUIREの追加
3. **83-86行目**: awaitRequestMessageの呼び出し
4. **90-98行目**: disable選択時のclient.setConfig呼び出し

#### Step 3: コマンド登録を理解する

コマンドの登録箇所を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | provider.lua | `script/provider/provider.lua` | workspace/executeCommandの登録（977-1021行目） |

**主要処理フロー**:
- **1008-1010行目**: lua.autoRequireコマンドのハンドリング

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

```
workspace/executeCommand (provider.lua:1008)
    │
    └─ require('core.command.autoRequire') (provider.lua:1009)
           │
           └─ autoRequire(data) (autoRequire.lua:133)
                  │
                  └─ askAutoRequire() (autoRequire.lua:69)
                         │
                         ├─ lang.script.COMPLETION_DISABLE_AUTO_REQUIRE
                         │
                         └─ client.awaitRequestMessage()
                                │
                                └─ client.setConfig() - disable選択時
```

### データフロー図

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

lua.autoRequire ───▶ askAutoRequire() ───▶ 選択肢リスト生成
コマンド               │                         │
                       │                         └─▶ ダイアログ表示
                       │
                       └─▶ ユーザー選択
                               │
                               ├─ disable選択 ───▶ setConfig()
                               │                      │
                               │                      └─▶ autoRequire=false
                               │
                               └─ その他 ───▶ 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` | ローカライズ | 英語メッセージ定義 |
| client.lua | `script/client.lua` | ソース | クライアント通信・設定処理 |
