# バッチ設計書 17---doc

## 概要

本ドキュメントは、ドキュメントを生成するCLIコマンド `--doc` のバッチ設計書です。

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

このCLIコマンドは、指定されたワークスペース内のLuaコードからAPIドキュメントを自動生成します。LuaDoc/EmmyDoc形式のアノテーションを解析し、JSON形式とMarkdown形式のドキュメントファイルを出力します。

**業務上の目的・背景**：Luaプロジェクトの開発において、コード内のアノテーションからAPIドキュメントを自動生成する機能は、ドキュメント作成の手間を削減し、コードとドキュメントの一貫性を保つために重要です。このコマンドにより、グローバル変数、関数、クラス、エイリアスなどの定義からドキュメントを自動抽出し、開発者向けのリファレンスを生成できます。

**バッチの実行タイミング**：リリース前のドキュメント生成時、CI/CDパイプラインでのドキュメント自動生成時、または手動でのドキュメント更新時に実行されます。

**主要な処理内容**：
1. ワークスペースの初期化とファイル読み込み
2. グローバル変数とエクスポート可能な要素の収集
3. 各要素の詳細情報（説明、型、フィールド、メソッド等）の抽出
4. ビルドスクリプト（設定ファイル）によるカスタマイズの適用
5. JSON形式とMarkdown形式でのドキュメント出力

**前後の処理との関連**：言語サーバーの解析機能を内部で使用します。`--doc_update` オプションと組み合わせることで、既存のドキュメントを更新することも可能です。

**影響範囲**：指定された出力ディレクトリに `doc.json` と `doc.md` ファイルが生成されます。

## バッチ種別

ドキュメント生成・APIリファレンス出力

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動/CI/CD） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 手動 / CI/CDパイプライン |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| lua-language-server実行可能ファイルが存在 | CLIを実行するための本体 |
| 有効なワークスペースパスの指定 | ドキュメント生成対象のディレクトリが存在すること |
| LuaDoc/EmmyDocアノテーション付きのソースコード | ドキュメント生成の元となるアノテーションが必要 |

### 実行可否判定

`--doc` または `--doc_update` オプションが指定されている場合、main.luaからcli/init.luaを経由してドキュメント生成モードで起動します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --doc | string | Yes* | - | ドキュメント生成対象のワークスペースパス |
| --doc_out_path | string | No | カレントディレクトリ | ドキュメント出力先パス |
| --doc_update | string | No | - | 既存ドキュメント（doc.json）のあるパス |
| --configpath | string | No | - | 設定ファイルのパス |
| --locale | string | No | en-us | 言語設定 |

*`--doc_update` 指定時は `--doc` は不要（doc.jsonから読み取り）

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| ワークスペース内Luaファイル | .luaファイル | アノテーション付きソースコード |
| .luarc.json / .luarc.lua | 設定ファイル | プロジェクト固有の設定 |
| Lua.docScriptPath | Luaスクリプト | ドキュメント生成のカスタマイズ |
| doc.json（--doc_update時） | JSON | 更新対象の既存ドキュメント |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| doc.json | JSON | 機械可読なAPIドキュメント |
| doc.md | Markdown | 人間可読なAPIドキュメント |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | doc.json、doc.md |
| 出力先 | --doc_out_path で指定、またはカレントディレクトリ |
| 文字コード | UTF-8 |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. CLI引数の解析
   └─ main.luaでグローバル変数DOCに値を設定

2. ドキュメント生成モード判定
   └─ cli/init.luaでDOCまたはDOC_UPDATEが設定されているか確認

3. cli/doc/init.lua:runCLI()の呼び出し
   └─ ワークスペースURIの生成
   └─ 設定ファイルパスの解決

4. 言語クライアントの初期化
   └─ lclientの起動
   └─ 診断機能の無効化（パフォーマンス向上）
   └─ hover.expandAliasの無効化

5. ワークスペースの準備
   └─ ws.awaitReady()で読み込み完了を待機

6. ビルドスクリプトの注入
   └─ injectBuildScript()でカスタマイズを適用

7. グローバル要素の収集
   └─ gatherGlobals()でエクスポート可能な要素を取得

8. ドキュメントオブジェクトの生成
   └─ makeDocs()で各要素の詳細を抽出
   └─ 進捗表示

9. シリアライズと出力
   └─ serializeAndExport()でJSON/MD出力
   └─ 出力パスの表示
```

### フローチャート

```mermaid
flowchart TD
    A[コマンド実行] --> B[引数解析]
    B --> C{--doc または --doc_update?}
    C -->|No| D[通常処理へ]
    C -->|Yes| E[runCLI呼び出し]
    E --> F[ワークスペースURI生成]
    F --> G[lclient初期化]
    G --> H[ワークスペース読み込み待機]
    H --> I[ビルドスクリプト注入]
    I --> J[グローバル要素収集]
    J --> K[ドキュメント生成]
    K --> L{エラー?}
    L -->|Yes| M[エラー出力]
    L -->|No| N[JSON/MD出力]
    N --> O[出力パス表示]
    O --> P[終了]
    M --> P
```

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

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

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | パス不正 | 指定されたワークスペースが存在しない | 有効なパスを指定する |
| - | 型エラー | --docの値が文字列でない | 正しい形式で指定する |
| - | URI変換エラー | パスからURIへの変換に失敗 | パス形式を確認する |
| - | ビルドスクリプトエラー | カスタムスクリプトの読み込みに失敗 | スクリプトを確認する |
| - | ファイル保存エラー | 出力先への書き込みに失敗 | 権限・空き容量を確認 |

### リトライ仕様

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

### 障害時対応

エラー発生時はエラーメッセージを出力して終了します。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（読み取り主体） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数百〜数千のグローバル定義 |
| 目標処理時間 | プロジェクトサイズに依存 |
| メモリ使用量上限 | 言語サーバー標準 |

## 排他制御

ファイル出力時の競合を防ぐため、同時実行は推奨されません。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗表示 | 処理中 | 進捗バー（例: ">>>>>===== 50/100"） |
| 完了メッセージ | 処理完了時 | 出力ファイルパス |

## 監視・アラート

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

## 備考

- このコマンドは `script/cli/doc/init.lua` と `script/cli/doc/export.lua` で実装されています
- `Lua.docScriptPath` 設定でドキュメント生成のカスタマイズが可能です
- `reinstantiateModule` 関数によりサンドボックス化されたモジュールでビルドスクリプトが実行されます
- 出力されるJSONには以下の情報が含まれます：
  - type: doc.class, doc.alias, function, variable等
  - name: 要素名
  - desc: 説明文
  - fields: フィールド一覧
  - defines: 定義箇所
  - start/finish: 位置情報
- Markdown出力はJSONを元に自動生成されます
- `luals.config` セクションには生成時の設定情報が含まれます
