# 通知設計書 8-MWS_WCONFIG_UPDATED

## 概要

本ドキュメントは、Lua Language Server におけるワークスペース設定更新完了通知（MWS_WCONFIG_UPDATED）の設計仕様を定義する。

### 本通知の処理概要

この通知は、ワークスペース設定（.luarc.json等）の更新が正常に完了したことをユーザーに通知するメッセージである。言語サーバーがワークスペース固有の設定を変更し、ファイルへの保存が成功した場合に表示される。

**業務上の目的・背景**：Lua Language Server は、ワークスペースごとに異なる設定をサポートしている。例えば、特定のプロジェクトでのみ有効な診断設定、ライブラリパス、ランタイムバージョンなどを .luarc.json ファイルに保存できる。この通知により、ワークスペース設定の更新が成功したことをユーザーに確認してもらう。

**通知の送信タイミング**：ワークスペース設定ファイル（.luarc.json等）の保存処理が成功した時点で送信される。

**通知の受信者**：エディタを使用している開発者（ユーザー）。Info レベルのメッセージとして表示される。

**通知内容の概要**：「ワークスペース設定が更新されました。」という確認メッセージが表示される。

**期待されるアクション**：特別なアクションは不要。ユーザーはワークスペース設定が正常に更新されたことを確認できる。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期 |
| 優先度 | 低 |
| リトライ | 無 |

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

LSP クライアントに対して直接送信される。

## 通知テンプレート

### メッセージ通知の場合

| 項目 | 内容 |
|-----|------|
| メッセージタイプ | Info |
| ボタン | なし |

### 本文テンプレート

```
Workspace setting updated.
```

日本語:
```
ワークスペース設定が更新されました。
```

中国語（簡体）:
```
工作区配置已更新。
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | 固定メッセージ | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| システムイベント | ワークスペース設定保存成功 | .luarc.json等への書き込み成功 | ワークスペース設定ファイルの保存が正常に完了した場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 保存失敗 | 設定の保存に失敗した場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[設定変更要求] --> B{グローバル設定?}
    B -->|Yes| C[ユーザー設定ファイル更新]
    B -->|No| D[ワークスペース設定ファイル更新]
    D --> E{書き込み成功?}
    E -->|Yes| F[MWS_WCONFIG_UPDATED通知]
    E -->|No| G[エラー通知]
    C --> H[MWS_UCONFIG_UPDATED通知]
    F --> I[終了]
    G --> I
    H --> I
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない（インメモリ処理）。

### 更新対象

| 対象 | 更新内容 | 用途 |
|------|---------|------|
| .luarc.json | 設定値の更新 | ワークスペース固有設定の永続化 |
| .luarc.jsonc | 設定値の更新 | コメント付きワークスペース設定 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | この通知は成功時のみ送信 | - |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | なし |

### 配信時間帯

制限なし

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

- 固定メッセージのため機密情報は含まれない
- 変更された設定の詳細は含まれない

## 備考

- MWS_UCONFIG_UPDATED（No.7）はユーザー設定（グローバル）用
- ワークスペース設定は .luarc.json または .luarc.jsonc に保存

---

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

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

### 推奨読解順序

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

メッセージ定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | script.lua | `locale/en-us/script.lua` | 203-204行目: MWS_WCONFIG_UPDATED 定義 |
| 1-2 | script.lua | `locale/ja-jp/script.lua` | 203-204行目: 日本語訳 |

**読解のコツ**: 固定メッセージで変数プレースホルダーなし。UCONFIG（User Config）とWCONFIG（Workspace Config）の違いに注意。

#### Step 2: ワークスペース設定保存を理解する

tryModifyRC関数の実装を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | client.lua | `script/client.lua` | 407-445行目: tryModifyRC 関数 |

**主要処理フロー**:
1. **413-418行**: .luarc.jsonc または .luarc.json のパスを取得
2. **423行**: util.loadFile でファイル読み込み
3. **436行**: editConfigJson で設定編集
4. **441行**: util.saveFile で保存

#### Step 3: 設定保存の流れを理解する

setConfig内でのワークスペース設定更新を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | client.lua | `script/client.lua` | 559-564行目: tryModifyRC呼び出し |

**主要処理フロー**:
- **562行**: tryModifyRC(scp.uri, finalChanges, false) - 既存ファイル更新
- **564行**: tryModifyRC(scp.uri, finalChanges, true) - ファイル作成も許可

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

```
client.setConfig (client.lua:520)
    │
    ├─ [ワークスペースあり]
    │      │
    │      └─ for each scp in ws.folders (560行)
    │             │
    │             ├─ tryModifySpecifiedConfig (561行)
    │             │
    │             ├─ tryModifyRC(..., false) (562行)
    │             │      └─ 既存の.luarc.json更新
    │             │
    │             ├─ tryModifyClient (563行)
    │             │
    │             └─ tryModifyRC(..., true) (564行)
    │                    └─ .luarc.json作成許可
    │
    └─ [成功後]
           └─ MWS_WCONFIG_UPDATED通知
```

### データフロー図

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

設定変更要求        ───▶  setConfig()              ───▶  更新完了通知
(ライブラリ追加等)        │
                         ├─ tryModifySpecifiedConfig
                         │
                         ├─ tryModifyRC
                         │      │
                         │      ├─ .luarc.jsonc 確認
                         │      ├─ .luarc.json 確認
                         │      └─ editConfigJson
                         │             └─ util.saveFile
                         │
                         └─ [成功]
                                └─ MWS_WCONFIG_UPDATED
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| script.lua | `locale/en-us/script.lua` | ローカライズ | メッセージ定義（203-204行） |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
| client.lua | `script/client.lua` | ソース | tryModifyRC, setConfig 実装 |
| .luarc.json | ワークスペースルート | 設定ファイル | ワークスペース固有設定 |
