# 通知設計書 19-CONFIG_MODIFY_FAIL_NO_WORKSPACE

## 概要

本ドキュメントは、Lua Language Serverにおける「設定変更失敗（ワークスペースなし）」通知（CONFIG_MODIFY_FAIL_NO_WORKSPACE）の設計仕様を定義する。この通知は、単一ファイルモード（ワークスペースが開かれていない状態）で設定変更を試みた際に、.luarc.jsonファイルを作成できないことをユーザーに警告するメッセージである。

### 本通知の処理概要

**業務上の目的・背景**：Lua Language Serverは、ワークスペース（フォルダ）を開いて使用する場合と、単一ファイルを開いて使用する場合がある。ワークスペースモードでは、プロジェクトルートに.luarc.jsonファイルを作成して設定を保存できる。しかし、単一ファイルモードではプロジェクトルートが存在しないため、.luarc.jsonファイルの作成場所が不明確となる。また、クライアント側で設定変更をサポートしていない場合もある。このような状況をユーザーに通知し、手動での設定変更方法を案内するために本通知が必要である。

**通知の送信タイミング**：設定変更処理（`client.lua`の`setConfig`関数）で、ワークスペースが0個（単一ファイルモード）かつ設定変更が完了できなかった場合に送信される。

**通知の受信者**：LSPクライアント（VSCode等のエディタ）を通じてユーザーに表示される。警告メッセージとしてエディタのUI上にポップアップ表示される。

**通知内容の概要**：「設定の変更に失敗しました：.luarc.jsonファイルの作成にはワークスペースが必要ですが、現在は単一ファイルモードになっています。」というメッセージが表示され、手動で変更すべき設定内容も併せて表示される。

**期待されるアクション**：ユーザーはフォルダを開いてワークスペースモードに切り替えるか、表示された設定内容を手動でユーザー設定に追加することが期待される。

## 通知種別

アプリ内通知（LSP Window Message - Warning）

## 送信仕様

### 基本情報

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

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

LSPプロトコルに従い、接続中のLSPクライアントに対してwindow/showMessage通知を送信する。受信者の決定は不要（接続中のクライアントすべてに送信）。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 通知タイプ | window/showMessage |
| メッセージタイプ | Warning（警告） |

### 本文テンプレート

```
設定の変更に失敗しました：
* `.luarc.json` ファイルの作成にはワークスペースが必要ですが、現在は単一ファイルモードになっています。
* クライアントはサーバー側からの設定変更をサポートしていません。

以下の設定を手動で変更してください：
{manualConfigMessage}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| manualConfigMessage | 手動で変更すべき設定内容 | buildMaunuallyMessage関数 | Yes |
| lang.script.CONFIG_MODIFY_FAIL_NO_WORKSPACE | メッセージテンプレート | locale/ja-jp/script.lua | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 設定変更 | setConfig呼び出し | #ws.folders == 0 かつ #finalChanges > 0 | 単一ファイルモードで設定変更残り |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| #ws.folders > 0 | ワークスペースモードの場合 |
| #finalChanges == 0 | 設定変更がすべて完了した場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[setConfig呼び出し] --> B[設定変更試行]
    B --> C[tryModifyClientGlobal]
    C --> D{#ws.folders == 0?}
    D -->|Yes| E[tryModifySpecifiedConfig - nil]
    D -->|No| F[ワークスペースごとに処理]
    E --> G[tryModifyClient - nil]
    G --> H{#finalChanges > 0?}
    H -->|No| I[処理完了]
    H -->|Yes| J[m.showMessage - Warning]
    J --> K[CONFIG_MODIFY_FAIL_NO_WORKSPACE通知]
    K --> L[手動設定案内]
    F --> M[tryModifySpecifiedConfig]
    M --> N[tryModifyRC]
    N --> O[tryModifyClient]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| ws.folders | ワークスペースフォルダ一覧 | 空の場合は単一ファイルモード |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 失敗時は更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ワークスペースなし | 単一ファイルモード | 警告表示、手動設定案内 |
| クライアント非対応 | 設定変更機能なし | 警告表示、手動設定案内 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（設定変更操作時）

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

- 設定変更内容がメッセージに含まれるが、ローカル表示のみ
- 手動設定案内により、ユーザーが意図しない設定を行うリスクを軽減

## 備考

- buildMaunuallyMessage関数で手動設定案内を生成
- add/set/propの3種類の設定変更アクションに対応
- WINDOW_MANUAL_CONFIG_ADD/SET/PROPメッセージを使用

---

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

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

### 推奨読解順序

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

設定変更の基本構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | client.lua | `script/client.lua` | config.change型の構造（行202-208） |

**読解のコツ**: config.changeのkey、action、value、propフィールドを把握する。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | client.lua | `script/client.lua` | setConfig関数（行522-572） |

**主要処理フロー**:
1. **行522**: `function m.setConfig(changes, onlyMemory)` - 関数定義
2. **行549-557**: 単一ファイルモードの処理
3. **行552-556**: finalChanges残りがある場合
4. **行553-554**: buildMaunuallyMessage呼び出し
5. **行555**: `m.showMessage('Warning', lang.script('CONFIG_MODIFY_FAIL_NO_WORKSPACE', manuallyModifyConfig))` - 通知送信

#### Step 3: 手動設定メッセージ生成を理解する

buildMaunuallyMessage関数の実装を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | client.lua | `script/client.lua` | buildMaunuallyMessage関数（行505-518） |

**主要処理フロー**:
- **行507-515**: add/set/propアクションに応じたメッセージ生成
- **行517**: table.concatで結合

#### Step 4: 言語リソースを理解する

通知メッセージの定義を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | script.lua | `locale/ja-jp/script.lua` | CONFIG_MODIFY_FAIL_NO_WORKSPACE定義（行626-634） |

**主要処理フロー**:
- **行626-634**: 複数行のメッセージテンプレート

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

```
client.lua
    │
    └─ m.setConfig(changes, onlyMemory)
           │
           ├─ 各changeをconfig.add/set/propで適用
           │
           ├─ tryModifyClientGlobal(finalChanges)
           │
           └─ #ws.folders == 0 の場合
                  │
                  ├─ tryModifySpecifiedConfig(nil, finalChanges)
                  │
                  ├─ tryModifyClient(nil, finalChanges)
                  │
                  └─ #finalChanges > 0 の場合
                         │
                         ├─ buildMaunuallyMessage(finalChanges)
                         │
                         └─ m.showMessage('Warning',
                                lang.script('CONFIG_MODIFY_FAIL_NO_WORKSPACE', ...))
```

### データフロー図

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

設定変更リスト ───▶ setConfig()
                         │
                         ▼
                  各変更試行
                         │
                         ▼ (単一ファイルモード)
                  tryModifySpecifiedConfig(nil, ...)
                  tryModifyClient(nil, ...)
                         │
                         ▼ (変更残りあり)
                  buildMaunuallyMessage(finalChanges)
                         │
                         ▼
                  lang.script('CONFIG_MODIFY_FAIL_NO_WORKSPACE', ...)
                         │
                         ▼
                  m.showMessage() ───▶ window/showMessage通知
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| client.lua | `script/client.lua` | ソース | 設定変更処理・setConfig関数 |
| script.lua | `locale/ja-jp/script.lua` | 言語リソース | 日本語メッセージ定義 |
| workspace.lua | `script/workspace/workspace.lua` | ソース | ワークスペース管理 |
| config.lua | `script/config.lua` | ソース | 設定管理 |
