# 通知設計書 61-WINDOW_MANUAL_CONFIG_ADD

## 概要

本ドキュメントは、Lua Language Server における `WINDOW_MANUAL_CONFIG_ADD` 通知の設計仕様を定義する。この通知は、クライアントがサーバー側からの設定変更をサポートしていない場合に、ユーザーに対して設定に要素を追加する方法を手動で案内するために使用される。

### 本通知の処理概要

**業務上の目的・背景**：Lua Language Serverは、ユーザーの開発体験を向上させるために、サーバー側から動的に設定を変更する機能を提供する。しかし、すべてのLSPクライアントがこの機能をサポートしているわけではない。そのような場合、ユーザーが手動で設定ファイルを編集できるよう、具体的な手順を案内する必要がある。本通知は、配列型の設定に新しい要素を追加する際の案内メッセージを生成する。

**通知の送信タイミング**：サーバーが設定変更を試みたが、クライアントが設定変更機能をサポートしていない場合、または自動変更に失敗した場合に送信される。具体的には、`client.setConfig`関数内で設定変更が完了できなかった際に、手動変更用のメッセージとして使用される。

**通知の受信者**：IDEやエディタを使用している開発者（ユーザー）に対して送信される。

**通知内容の概要**：設定キーと追加すべき値を含む、手動設定変更の案内メッセージ。例：「`{key}` に要素 `{value}` を追加してください」

**期待されるアクション**：ユーザーは案内に従って、設定ファイル（`.luarc.json`やVS Codeの`settings.json`など）を手動で編集し、指定された要素を設定に追加する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

LSPプロトコルを通じて、接続中のクライアント（IDE/エディタ）に直接送信される。送信先の決定ロジックは特になく、現在接続中のクライアントが対象となる。

## 通知テンプレート

### メール通知の場合

該当なし（LSP通知のみ）

### 本文テンプレート

英語:
```
`{key}`: add element `{value}` ;
```

日本語:
```
`{key}` に要素 `{value}` を追加します;
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| key | 設定キー名（例: "Lua.workspace.library"） | config.change.key | Yes |
| value | 追加する値 | config.change.value | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 内部処理 | 設定変更失敗 | クライアントがサーバー側設定変更を非サポート、かつaction='add'の変更がある場合 | buildMaunuallyMessage関数で使用 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 設定変更成功 | クライアントまたは設定ファイルへの自動変更が成功した場合は送信されない |
| 変更リストが空 | finalChangesが空の場合は送信されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[client.setConfig呼び出し] --> B[設定変更試行]
    B --> C{自動変更成功?}
    C -->|Yes| D[終了]
    C -->|No| E[finalChangesに残存あり?]
    E -->|No| D
    E -->|Yes| F[buildMaunuallyMessage呼び出し]
    F --> G{action=='add'?}
    G -->|Yes| H[WINDOW_MANUAL_CONFIG_ADDメッセージ生成]
    G -->|No| I[他のメッセージ生成]
    H --> J[window/showMessage送信]
    I --> J
    J --> D
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | この通知自体がエラー処理の結果として送信される | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（随時送信）

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

- 設定値の内容はログに記録されるが、機密情報は通常含まれない
- ユーザーの設定ファイルパスが表示される可能性があるが、セキュリティリスクは低い

## 備考

- この通知は`WINDOW_CLIENT_NOT_SUPPORT_CONFIG`または`WINDOW_LCONFIG_NOT_SUPPORT_CONFIG`と組み合わせて表示される
- 複数の設定変更がある場合、各変更ごとにこのメッセージが生成され、リスト形式で表示される

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | client.lua | `script/client.lua` | config.change型の定義（202-208行目）を確認し、key/action/valueの構造を理解する |

**読解のコツ**: `---@class config.change`アノテーションでデータ構造が定義されている

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | client.lua | `script/client.lua` | setConfig関数（520-572行目）が設定変更の起点となる |

**主要処理フロー**:
1. **522-541行**: 設定変更をconfig.add/set/propで適用
2. **549-571行**: 自動変更を試行し、失敗した場合にメッセージを生成

#### Step 3: メッセージ生成ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | client.lua | `script/client.lua` | buildMaunuallyMessage関数（504-518行目）でWINDOW_MANUAL_CONFIG_ADDが使用される |

**主要処理フロー**:
- **509-510行**: action='add'の場合にWINDOW_MANUAL_CONFIG_ADDメッセージを生成

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

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

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

```
client.setConfig (520行)
    |
    +-- config.add (526行)
    |      └-- finalChangesに追加
    |
    +-- tryModifyClientGlobal (551行)
    |      └-- 設定変更試行
    |
    +-- tryModifySpecifiedConfig (553行, 561行)
    |      └-- 設定ファイル変更試行
    |
    +-- tryModifyClient (554行, 563行)
    |      └-- クライアント変更試行
    |
    +-- buildMaunuallyMessage (556行, 567行)
    |      └-- WINDOW_MANUAL_CONFIG_ADD (510行)
    |
    └-- m.showMessage (557行, 567行)
           └-- window/showMessage送信
```

### データフロー図

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

config.change  ───▶ setConfig             ───▶ (自動変更成功)
  ├ key                |
  ├ action='add'       |
  └ value              v
                  tryModify...  ───▶ (失敗) ───▶ buildMaunuallyMessage
                                                        |
                                                        v
                                              lang.script(WINDOW_MANUAL_CONFIG_ADD)
                                                        |
                                                        v
                                              window/showMessage ───▶ クライアント表示
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| client.lua | `script/client.lua` | ソース | 設定変更ロジックとメッセージ生成 |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージテンプレート |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージテンプレート |
| language.lua | `script/language.lua` | ソース | 多言語テンプレート展開 |
| proto.lua | `script/proto.lua` | ソース | LSP通知送信 |
