# 通知設計書 18-CONFIG_MODIFY_FAIL_SYNTAX_ERROR

## 概要

本ドキュメントは、Lua Language Serverにおける「設定変更失敗（構文エラー）」通知（CONFIG_MODIFY_FAIL_SYNTAX_ERROR）の設計仕様を定義する。この通知は、設定ファイルを自動変更しようとした際に、既存の設定ファイルに構文エラーがあり変更できない場合にユーザーに警告するエラーメッセージである。

### 本通知の処理概要

**業務上の目的・背景**：Lua Language Serverは、ユーザーの操作（コードアクション等）に応じて設定ファイルを自動的に変更する機能を持つ。例えば、「このライブラリをワークスペースに追加」などの操作で設定ファイルが編集される。しかし、既存の設定ファイルに構文エラー（JSONの文法エラー等）がある場合、安全に編集を行うことができない。このような状況をユーザーに通知し、設定ファイルの修正を促すために本通知が必要である。

**通知の送信タイミング**：設定ファイルの自動編集処理（`client.lua`の`editConfigJson`関数）で、既存のJSONファイルのパースに失敗した場合に送信される。

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

**通知内容の概要**：「設定ファイル中に構文エラーがあったため、設定を変更できませんでした：{path}{error}」というメッセージが表示され、問題のあるファイルのパスと具体的な構文エラーを明示する。

**期待されるアクション**：ユーザーは設定ファイルを開き、表示されたエラー情報に基づいて構文エラーを修正した後、再度設定変更操作を行うことが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 通知タイプ | window/showMessage |
| メッセージタイプ | Error（エラー） |

### 本文テンプレート

```
設定ファイル中に構文エラーがあったため、設定を変更できませんでした：{path}{error}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| path | 設定ファイルのパス | 関数引数 | Yes |
| error | 構文エラーの詳細（`ERROR`以降） | pcall結果のエラー文字列 | Yes |
| lang.script.CONFIG_MODIFY_FAIL_SYNTAX_ERROR | メッセージテンプレート | locale/ja-jp/script.lua | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 設定自動変更 | editConfigJson呼び出し | jsonc.decode_jsonc失敗 | JSON構文エラー |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ファイル読み込み失敗 | CONFIG_LOAD_FAILEDが送信される |
| パース成功 | 通常の編集処理へ進む |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[editConfigJson呼び出し] --> B[util.loadFile実行]
    B --> C{text取得成功?}
    C -->|No| D[CONFIG_LOAD_FAILED]
    C -->|Yes| E[jsonc.decode_jsonc実行]
    E --> F{パース成功?}
    F -->|Yes| G[設定変更処理]
    F -->|No| H[m.showMessage - Error]
    H --> I[CONFIG_MODIFY_FAIL_SYNTAX_ERROR通知]
    I --> J[return nil]
    G --> K[jsone.edit実行]
    K --> L[編集済みテキスト返却]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| util.loadFile | ファイル読み込み | 設定ファイル取得 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | パースエラー時は更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| JSON構文エラー | 設定ファイルのJSONが不正 | エラー表示、処理中止 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 設定ファイルのパスとエラー詳細がメッセージに含まれるが、ローカル表示のみ
- 構文エラーのあるファイルは編集されないため、データ破損を防止

## 備考

- エラー文字列から`ERROR`以降を抽出して表示
- 構文エラーの位置情報（行番号等）が含まれる場合あり
- 編集処理はjsone.edit（json-edit）を使用

---

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

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

### 推奨読解順序

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

設定編集の基本構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | jsone.lua | `script/json-edit.lua` | JSON編集機能の構造 |

**読解のコツ**: jsone.editでJSONを安全に編集する仕組みを把握する。

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

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

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

**主要処理フロー**:
1. **行337**: `local function editConfigJson(uri, path, changes)` - 関数定義
2. **行338**: `local text = util.loadFile(path)` - ファイル読み込み
3. **行339-341**: 読み込み失敗時のCONFIG_LOAD_FAILEDエラー
4. **行343**: `local suc, res = pcall(jsonc.decode_jsonc, text)` - JSONパース
5. **行344-346**: パース失敗時のCONFIG_MODIFY_FAIL_SYNTAX_ERRORエラー
6. **行345**: `m.showMessage('Error', lang.script('CONFIG_MODIFY_FAIL_SYNTAX_ERROR', path .. res:match 'ERROR(.+)$'))` - 通知送信

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | script.lua | `locale/ja-jp/script.lua` | CONFIG_MODIFY_FAIL_SYNTAX_ERROR定義（行624-625） |

**主要処理フロー**:
- **行624-625**: `CONFIG_MODIFY_FAIL_SYNTAX_ERROR = '設定ファイル中に構文エラーがあったため、設定を変更できませんでした：{}'`

#### Step 4: 呼び出し元を理解する

editConfigJsonの呼び出し元を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | client.lua | `script/client.lua` | tryModifySpecifiedConfig、tryModifyRC関数 |

**主要処理フロー**:
- **行375-405**: tryModifySpecifiedConfig関数
- **行407-445**: tryModifyRC関数

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

```
client.lua
    │
    ├─ m.setConfig(changes, onlyMemory)
    │      │
    │      └─ tryModifySpecifiedConfig(uri, finalChanges)
    │             │
    │             └─ editConfigJson(uri, path, validChanges)
    │                    │
    │                    ├─ util.loadFile(path)
    │                    │
    │                    └─ pcall(jsonc.decode_jsonc, text)
    │                           │
    │                           └─ 失敗時: m.showMessage('Error',
    │                                  lang.script('CONFIG_MODIFY_FAIL_SYNTAX_ERROR', ...))
    │
    └─ tryModifyRC(uri, finalChanges, create)
           │
           └─ editConfigJson(uri, path, validChanges)
```

### データフロー図

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

設定ファイル ───▶ util.loadFile()
変更内容 ────┘       │
                     ▼
              jsonc.decode_jsonc()
                     │
                     ▼ (パース失敗時)
              res:match 'ERROR(.+)$' -- エラー抽出
                     │
                     ▼
              lang.script('CONFIG_MODIFY_FAIL_SYNTAX_ERROR', path .. error)
                     │
                     ▼
              m.showMessage() ───▶ window/showMessage通知
                     │
                     ▼
              return nil ───▶ 変更処理中止
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| client.lua | `script/client.lua` | ソース | 設定変更処理・editConfigJson関数 |
| script.lua | `locale/ja-jp/script.lua` | 言語リソース | 日本語メッセージ定義 |
| jsonc.lua | `script/jsonc.lua` | ソース | JSON with Comments パーサー |
| json-edit.lua | `script/json-edit.lua` | ソース | JSON編集機能 |
| utility.lua | `script/utility.lua` | ソース | loadFile関数 |
