# 通知設計書 87-CLI_DOC_DONE

## 概要

本ドキュメントは、Lua Language Serverのコマンドラインドキュメント生成機能における「ドキュメントエクスポート完了」通知（CLI_DOC_DONE）の設計を記載する。

### 本通知の処理概要

CLI_DOC_DONEは、コマンドラインでドキュメント生成（--DOCオプション）が正常に完了した際に表示される最終結果メッセージである。

**業務上の目的・背景**：ドキュメント生成処理が完了した際、ユーザーは生成されたドキュメントの出力先を知る必要がある。本通知は処理の完了を伝えるとともに、生成されたファイルのパスを明示することで、ユーザーが直ちに結果を確認できるようにする。

**通知の送信タイミング**：ドキュメント生成処理が完了し、JSONファイルとMarkdownファイルの出力が成功した直後に表示される。

**通知の受信者**：コマンドラインで`--DOC`オプションを実行しているユーザー。標準出力（コンソール）に直接表示される。

**通知内容の概要**：「ドキュメントのエクスポートが完了しました！」というメッセージに続いて、生成されたファイルのパスが一覧表示される。

**期待されるアクション**：ユーザーは表示されたパスにある生成済みドキュメント（doc.json、doc.md）を確認し、必要に応じてさらなる加工やドキュメントサイトへの組み込みを行う。

## 通知種別

コンソール出力（CLI標準出力）

## 送信仕様

### 基本情報

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

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

コマンドラインでドキュメント生成を実行しているプロセスの標準出力に直接出力される。ドキュメント生成が正常に完了した場合に表示される。

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | 標準出力（stdout） |
| 形式 | プレーンテキスト（複数行） |

### 本文テンプレート

```
日本語:
ドキュメントのエクスポートが完了しました！
元データ: {jsonPath}
Markdown(例): {mdPath}

英語:
Documentation exported:
{jsonPath}
{mdPath}
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| doc.json | JSON | 常に生成 | APIドキュメントの構造化データ |
| doc.md | Markdown | 常に生成 | Markdown形式のドキュメント（サンプル） |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| jsonPath | 生成されたJSONファイルのパス | DOC_OUT_PATH + '/doc.json' | Yes（日本語版） |
| mdPath | 生成されたMarkdownファイルのパス | DOC_OUT_PATH + '/doc.md' | Yes（日本語版） |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| CLI実行 | ドキュメント生成完了 | serializeAndExport()成功 | ドキュメント出力成功時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ドキュメント生成失敗 | エラーが発生した場合は表示しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ドキュメント生成処理] --> B[serializeAndExport実行]
    B --> C{成功?}
    C -->|Yes| D[CLI_DOC_DONE表示]
    C -->|No| E[エラー処理]
    D --> F[出力ファイルパス一覧表示]
    F --> G[終了]
    E --> G
```

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

### 参照テーブル一覧

本機能はデータベースを使用しない。

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | - | - |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| doc.json (ファイル) | CREATE | APIドキュメントをJSON形式で出力 |
| doc.md (ファイル) | CREATE | ドキュメントをMarkdown形式で出力 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ファイル書き込み失敗 | 出力パスに書き込み権限がない場合 | エラーを発生させ本通知は表示しない |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1回のドキュメント生成あたり | 最大1回 |
| 1日あたり上限 | なし |

### 配信時間帯

制限なし（CLI実行時のみ）

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

- ファイルパスが表示されるが、これはユーザーが指定したパスまたはカレントディレクトリ
- 生成されたドキュメントにはソースコードのコメントが含まれる可能性がある

## 備考

- 日本語版と英語版でメッセージ形式が異なる（日本語版はより詳細な説明付き）
- 出力パスは`DOC_OUT_PATH`で指定可能、未指定の場合はカレントディレクトリ
- LSP経由で呼び出された場合（makeDoc関数）は本通知は使用されない

---

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

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

### 推奨読解順序

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

処理の起点となる関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | init.lua | `script/cli/doc/init.lua` | `doc.runCLI()` 関数（176-256行目） |

**主要処理フロー**:
1. **249行目**: `serializeAndExport()` 呼び出し
2. **250行目**: `print(lang.script('CLI_DOC_DONE'))` で通知表示
3. **251-254行目**: 出力ファイルパス一覧の表示

#### Step 2: 出力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | export.lua | `script/cli/doc/export.lua` | `serializeAndExport()` 関数（310-360行目） |

**主要処理フロー**:
- **311-312行目**: 出力パスの構築
- **317行目**: JSON出力
- **352行目**: Markdown出力
- **359行目**: 出力パスの配列を返却

#### Step 3: ローカライゼーションを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | script.lua | `locale/en-us/script.lua` | 686-689行目でメッセージ定義 |
| 3-2 | script.lua | `locale/ja-jp/script.lua` | 687-692行目で日本語メッセージ定義 |

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

```
doc.runCLI() [init.lua:176]
    │
    ├─ ドキュメント生成準備
    │
    ├─ dirty_export.gatherGlobals() [init.lua:229]
    │
    ├─ dirty_export.makeDocs() [init.lua:231-242]
    │
    ├─ dirty_export.serializeAndExport() [init.lua:249]
    │      │
    │      ├─ util.saveFile(jsonPath) [export.lua:317]
    │      │
    │      └─ util.saveFile(mdPath) [export.lua:352]
    │
    ├─ print(CLI_DOC_DONE) [init.lua:250]
    │
    └─ 出力パス一覧表示 [init.lua:251-254]
```

### データフロー図

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

グローバル変数 ─────▶ documentObject() ───▶ docs テーブル
                                                  │
                                                  ▼
                            serializeAndExport() ───▶ doc.json
                                   │                    doc.md
                                   ▼
                         print(CLI_DOC_DONE) ───▶ コンソール出力
                                   │
                                   ▼
                         出力パス一覧 ───▶ コンソール出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| init.lua | `script/cli/doc/init.lua` | ソース | ドキュメント生成CLI処理 |
| export.lua | `script/cli/doc/export.lua` | ソース | ドキュメントエクスポート処理 |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージ定義 |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
| json-beautify.lua | `script/json-beautify.lua` | ソース | JSON整形出力 |
| markdown.lua | `script/provider/markdown.lua` | ソース | Markdown生成 |
