# 通知設計書 17-CONFIG_TYPE_ERROR

## 概要

本ドキュメントは、Lua Language Serverにおける「設定ファイル形式エラー」通知（CONFIG_TYPE_ERROR）の設計仕様を定義する。この通知は、設定ファイルがLuaまたはJSON形式でない場合にユーザーに警告するエラーメッセージである。

### 本通知の処理概要

**業務上の目的・背景**：Lua Language Serverは、設定ファイルとしてJSON形式（.luarc.json、.luarc.jsonc）またはLua形式（config.lua）をサポートしている。設定ファイルの内容を解析する際、ファイルの最初の非空白文字から形式を判別する。JSON形式は `{` で始まり、それ以外はLua形式として処理される。しかし、この判別が適切に行われない場合やサポートされていない形式の場合、ユーザーに通知して正しい形式への修正を促す必要がある。

**通知の送信タイミング**：設定ファイルの読み込み処理で、ファイル形式の判別に失敗した場合に送信される。現在のコード実装では、JSON（`{`で始まる）とLua（それ以外）の判別ロジックがあり、このメッセージは言語リソースとして定義されているが、実際の使用箇所は限定的である。

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

**通知内容の概要**：「設定ファイルは lua または json フォーマットでなければなりません：{path}」というメッセージが表示され、問題のあるファイルのパスを明示する。

**期待されるアクション**：ユーザーは設定ファイルの形式を確認し、JSONまたはLua形式に修正することが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
設定ファイルは lua または json フォーマットでなければなりません：{path}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| path | 問題のある設定ファイルのパス | 関数引数 | Yes |
| lang.script.CONFIG_TYPE_ERROR | メッセージテンプレート | locale/ja-jp/script.lua | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 設定ファイル読み込み | 形式判別処理 | サポートされていない形式 | JSONでもLuaでもない形式 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| JSON形式（`{`で始まる） | 正常処理 |
| Lua形式（`{`以外で始まる） | 正常処理 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[設定ファイル読み込み] --> B[最初の非空白文字を取得]
    B --> C{firstChar == '{'?}
    C -->|Yes| D[JSON形式として処理]
    C -->|No| E[Lua形式として処理]
    D --> F{パース成功?}
    E --> F
    F -->|Yes| G[設定適用]
    F -->|No| H[CONFIG_LOAD_ERROR]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | - | 形式判別のみ |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 形式不正 | サポートされていない形式 | エラー表示 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（設定ファイルアクセス時）

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

- 設定ファイルのパスがメッセージに含まれるが、ローカル表示のみ

## 備考

- 現在のloader.luaの実装では、CONFIG_TYPE_ERRORは直接使用されていない
- 形式判別は`buf:match '%S'`でfirstCharを取得し、`{`かどうかで判定
- `{`以外はすべてLua形式として処理されるため、このエラーが発生するケースは限定的
- 言語リソースとして定義されているが、将来の拡張のための予約の可能性あり

---

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

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

### 推奨読解順序

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

設定ファイルの形式判別ロジックを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | loader.lua | `script/config/loader.lua` | loadLocalConfig関数の形式判別 |

**読解のコツ**: `firstChar = buf:match '%S'`で最初の非空白文字を取得し、`{`かどうかで形式を判別することを把握する。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | loader.lua | `script/config/loader.lua` | loadLocalConfig関数（行44-85） |

**主要処理フロー**:
1. **行55**: `local buf = util.loadFile(path)` - ファイル読み込み
2. **行62**: `local firstChar = buf:match '%S'` - 最初の非空白文字取得
3. **行63**: `if firstChar == '{' then` - JSON形式判定
4. **行63-72**: JSON形式の処理
5. **行73-84**: Lua形式の処理（else節）

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

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

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

**主要処理フロー**:
- **行622-623**: `CONFIG_TYPE_ERROR = '設定ファイルは lua または json フォーマットでなければなりません：{}'`

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

```
loader.lua
    │
    └─ m.loadLocalConfig(uri, filename)
           │
           ├─ util.loadFile(path) -- ファイル読み込み
           │
           ├─ buf:match '%S' -- 最初の非空白文字取得
           │
           ├─ firstChar == '{' ?
           │      │
           │      ├─ Yes: jsonc.decode_jsonc(buf) -- JSON処理
           │      │
           │      └─ No: load(buf) -- Lua処理
           │
           └─ (CONFIG_TYPE_ERRORは現在未使用)
```

### データフロー図

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

設定ファイル内容 ───▶ buf:match '%S'
                            │
                            ▼
                   firstChar取得
                            │
                ┌───────────┴───────────┐
                │                       │
                ▼                       ▼
        firstChar == '{'          firstChar != '{'
                │                       │
                ▼                       ▼
        JSON処理                    Lua処理
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| loader.lua | `script/config/loader.lua` | ソース | 設定ローダー |
| script.lua | `locale/ja-jp/script.lua` | 言語リソース | 日本語メッセージ定義 |
| jsonc.lua | `script/jsonc.lua` | ソース | JSON with Comments パーサー |
