# バッチ設計書 12-configuration.lua

## 概要

本ドキュメントは、VSCode設定スキーマを生成するためのヘルパースクリプト `configuration.lua` のバッチ設計書です。

### 本バッチの処理概要

このバッチは、Lua言語サーバーの設定テンプレート（config.template）からVSCode拡張機能用のJSON Schema形式の設定定義を生成するヘルパーモジュールです。内部で使用される設定テンプレートを、VSCodeのsettings.json用のスキーマ形式に変換します。

**業務上の目的・背景**：Lua言語サーバーはVSCode拡張機能として動作する際、ユーザーがVSCodeの設定画面から各種オプションを設定できるようにする必要があります。VSCodeは設定の型チェックや入力補完のためにJSON Schema形式の設定定義を必要とします。このモジュールは、Lua言語サーバー内部で定義された設定テンプレートを、VSCodeが理解できる形式に自動変換することで、設定定義の二重管理を防ぎ、一貫性を保ちます。

**バッチの実行タイミング**：VSCode拡張機能のビルド時、または設定スキーマが必要な際にモジュールとしてrequireされて使用されます。直接実行されるスクリプトではなく、他のビルドスクリプトから呼び出されます。

**主要な処理内容**：
1. 設定テンプレート（config.template）の読み込み
2. 各設定項目の型をJSON Schema形式に変換（Boolean→boolean、String→string等）
3. デフォルト値の取得と適切な形式への変換
4. 列挙型（enum）の設定とその説明文の生成
5. Array型・Hash型の特殊処理（items、patternProperties等）
6. "Lua."プレフィックスを持つ設定項目のみを抽出

**前後の処理との関連**：VSCode拡張機能（vscode-lua）のビルドプロセスで使用されます。package.jsonのcontributes.configurationセクションの生成に利用されます。

**影響範囲**：VSCode拡張機能の設定スキーマ、ユーザーの設定入力体験

## バッチ種別

データ変換・スキーマ生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（モジュールとして呼び出し） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | require時に自動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| config.templateモジュールの存在 | 設定テンプレートが正しく定義されていること |
| jsonモジュールの存在 | JSON形式のnullや空オブジェクト生成に使用 |
| utilityモジュールの存在 | 文字列操作ユーティリティに使用 |

### 実行可否判定

モジュールとして読み込まれた時点で自動的に処理が実行され、変換結果がtableとして返されます。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | モジュールとして読み込むため引数なし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| config.template | Luaモジュール | 設定項目のテンプレート定義 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| return値 | Lua table | JSON Schema形式の設定定義テーブル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | なし（メモリ上のテーブルを返す） |
| 出力先 | - |
| 文字コード | - |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. モジュール初期化
   └─ json、config.template、utility モジュールを読み込み

2. 型変換関数の定義
   └─ getType: テンプレート型をJSON Schema型に変換

3. デフォルト値取得関数の定義
   └─ getDefault: デフォルト値をJSON形式で取得

4. 列挙型取得関数の定義
   └─ getEnum: 列挙値の取得
   └─ getEnumDesc: 列挙値の説明文を生成

5. 配列型処理関数の定義
   └─ insertArray: items定義の生成

6. ハッシュ型処理関数の定義
   └─ insertHash: properties/patternProperties定義の生成

7. 設定テンプレートの変換
   └─ "Lua."プレフィックスを持つ設定項目を抽出
   └─ 各項目をJSON Schema形式に変換

8. 変換結果の返却
   └─ configテーブルを返す
```

### フローチャート

```mermaid
flowchart TD
    A[モジュール読み込み開始] --> B[依存モジュール読み込み]
    B --> C[ヘルパー関数定義]
    C --> D[設定テンプレート走査]
    D --> E{Lua.プレフィックスあり?}
    E -->|なし| D
    E -->|あり| F[基本情報変換]
    F --> G{Array型?}
    G -->|はい| H[items定義生成]
    G -->|いいえ| I{Hash型?}
    H --> D
    I -->|はい| J[properties/patternProperties生成]
    I -->|いいえ| D
    J --> D
    D --> K{全項目処理完了?}
    K -->|いいえ| D
    K -->|はい| L[configテーブル返却]
    L --> M[モジュール終了]
```

## データベース操作仕様

### 操作別データベース影響一覧

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | データベースは使用しない |

### テーブル別操作詳細

データベース操作は行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Unknown type エラー | 未知のテンプレート型を検出 | getType関数内でerror()を発生させる |
| - | モジュール読み込みエラー | 依存モジュールが見つからない | 依存モジュールの配置を確認 |

### リトライ仕様

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

### 障害時対応

エラー発生時はLuaの標準エラーハンドリングにより処理が中断されます。

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（メモリ操作のみ） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数十〜数百の設定項目 |
| 目標処理時間 | ミリ秒単位 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

モジュールとして一度読み込まれた後はキャッシュされるため、排他制御は不要です。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| なし | - | ログ出力機能は実装されていない |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| なし | - | - |

## 備考

- このスクリプトは `tools/configuration.lua` に配置されています
- 返されるテーブルのキーは "Lua.xxx" 形式の設定名です
- 各設定項目には scope, type, default, enum, markdownDescription, markdownEnumDescriptions が含まれます
- scope は全て "resource" に設定されます
- markdownDescription は "%config.xxx%" 形式のローカライズキーとして生成されます
