# バッチ設計書 7-build-doc.lua

## 概要

本ドキュメントは、設定ドキュメントをMarkdown形式で生成するツール「build-doc.lua」の設計仕様を定義するものである。

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

build-doc.luaは、lua-language-serverの設定オプションをMarkdown形式のドキュメントとして生成するツールである。多言語対応しており、localeディレクトリ配下の各言語について設定ドキュメントを自動生成する。

**業務上の目的・背景**：lua-language-serverには多数の設定オプションがあり、ユーザーがこれらを理解するためのドキュメントが必要である。このツールにより、設定定義から自動的にドキュメントを生成でき、設定変更時のドキュメント更新漏れを防ぐことができる。また、多言語対応により、国際的なユーザーベースにも対応する。

**バッチの実行タイミング**：手動実行。設定オプションが追加・変更された場合、またはロケールファイルが更新された場合に実行する。

**主要な処理内容**：
1. 各言語のロケールファイル（setting.lua）を読み込み
2. 診断グループのロケール情報をマージ
3. 設定定義（configuration.lua）を読み込み
4. 各設定項目について、型、説明、デフォルト値、enum値をMarkdown形式で出力
5. doc/{言語}/config.mdに出力

**前後の処理との関連**：単独で実行される。生成されたドキュメントはdoc/ディレクトリに出力され、リポジトリに含まれる。

**影響範囲**：doc/配下の各言語ディレクトリのconfig.mdファイルが更新される。

## バッチ種別

ドキュメント生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Luaランタイム | Luaインタープリタが利用可能であること |
| localeディレクトリ | locale/配下に言語ディレクトリが存在すること |
| 設定定義 | configuration.luaが読み込み可能であること |

### 実行可否判定

プロジェクトルートディレクトリで実行すること。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | パラメータなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| locale/{lang}/setting.lua | Lua | 各言語のロケール定義 |
| tools/configuration.lua | Lua | 設定定義 |
| proto/diagnostic.lua | Lua | 診断グループ定義 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| doc/{lang}/config.md | Markdown | 設定ドキュメント |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | config.md |
| 出力先 | doc/{言語}/ |
| 文字コード | UTF-8 |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. 依存モジュール読み込み
   └─ bee.filesystem、configuration、markdown、utility、locale-loader、json-beautify、proto.diagnostic
2. 診断グループロケールマージ
   └─ diagnosticGroupsから各グループの診断名リストを生成
3. ロケールファイル読み込み
   └─ locale/配下の各言語ディレクトリからsetting.luaを読み込み
4. 各言語についてMarkdown生成
   └─ 設定項目をソート順に処理
   └─ 各項目について: 説明、型、enum、デフォルト値を出力
5. ファイル出力
   └─ doc/{言語}/config.mdに保存
```

### フローチャート

```mermaid
flowchart TD
    A[build-doc.lua開始] --> B[依存モジュール読み込み]
    B --> C[診断グループロケールマージ]
    C --> D[ロケールファイル読み込み]
    D --> E[言語ループ開始]
    E --> F[出力ディレクトリ作成]
    F --> G[設定項目ループ]
    G --> H[説明をMarkdown追加]
    H --> I[型情報をMarkdown追加]
    I --> J[enum値をMarkdown追加]
    J --> K[デフォルト値をMarkdown追加]
    K --> L{次の設定項目あり?}
    L -->|Yes| G
    L -->|No| M[config.mdに保存]
    M --> N{次の言語あり?}
    N -->|Yes| E
    N -->|No| O[完了]
```

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

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

本バッチはデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ロケール不在 | setting.luaが見つからない | ロケールファイルを確認 |
| - | 設定定義エラー | configuration.luaの形式が不正 | 設定定義を確認 |
| - | ディレクトリ作成失敗 | doc/ディレクトリに書き込み権限がない | 権限を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（手動リトライ） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

エラーメッセージを確認し、対象のファイルが正しく配置されているか確認する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 言語数 × 設定項目数 |
| 目標処理時間 | 数秒 |
| メモリ使用量上限 | Luaランタイム依存 |

## 排他制御

同一ディレクトリでの同時実行は非推奨。出力ファイルの競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | なし | - |
| 標準エラー | エラー発生時 | エラー詳細 |

## 監視・アラート

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

## 備考

- 説明文が%で囲まれている場合（例: %config.description%）、ロケールファイルから対応するテキストを取得
- 型表示は配列型（Array<T>）やオブジェクト型（object<string, T>）にも対応
- enum値がある場合、markdownEnumDescriptionsから説明を取得
- json-beautifyモジュールを使用してデフォルト値をJSON形式で出力
- 設定項目名から"Lua."プレフィックスを除去して表示
