# 通知設計書 88-CLI_DOC_WORKING

## 概要

本ドキュメントは、Lua Language Serverのコマンドラインドキュメント生成機能における「ドキュメント生成中」通知（CLI_DOC_WORKING）の設計を記載する。

### 本通知の処理概要

CLI_DOC_WORKINGは、ドキュメント生成処理が実行中であることを示す進捗メッセージである。主にLSP経由でドキュメント生成を実行した場合のプログレスダイアログで使用される。

**業務上の目的・背景**：ドキュメント生成処理は、大量のグローバル変数やクラス定義を解析するため時間がかかる場合がある。本通知は、ユーザーに処理が進行中であることを伝え、進捗率と共に現在の状況を可視化する。これにより、ユーザーは処理が停止しているのではなく正常に進行していることを確認できる。

**通知の送信タイミング**：ドキュメント生成処理中、各グローバル変数の処理が完了するたびにプログレスが更新される。LSP経由の場合はプログレスダイアログに、CLI経由の場合はコンソールにプログレスバーとして表示される。

**通知の受信者**：LSP経由の場合はVSCodeなどのエディタのプログレスダイアログ、CLI経由の場合は標準出力に表示される。

**通知内容の概要**：「ドキュメントを生成しています...」という形式で、ドキュメント生成が進行中であることを示す。

**期待されるアクション**：ユーザーは処理が完了するまで待機する。プログレス表示により、処理の進行状況を把握できる。

## 通知種別

- LSP経由：プログレスダイアログ（window/workDoneProgress）
- CLI経由：コンソール出力（標準出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（リアルタイム更新） |
| 優先度 | 中 |
| リトライ | なし |

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

LSP経由の場合はprogress APIを使用してクライアントに通知される。CLI経由の場合は標準出力に直接出力される。

## 通知テンプレート

### LSP経由（プログレスダイアログ）の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | LSP window/workDoneProgress |
| 形式 | プログレスダイアログ |

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

| 項目 | 内容 |
|-----|------|
| 出力先 | 標準出力（stdout） |
| 形式 | プログレスバー |

### 本文テンプレート

```
日本語:
ドキュメントを生成しています...

英語:
Building docs...
```

### 添付ファイル

なし

## テンプレート変数

なし（固定メッセージ。ただし進捗率は別途設定される）

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| LSP実行 | ドキュメント生成開始 | makeDoc()呼び出し時 | プログレスダイアログ作成 |
| CLI実行 | ドキュメント生成中 | makeDocs()呼び出し中 | 0.2秒ごとにプログレス更新 |

### 送信抑止条件

なし（常に表示）

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ドキュメント生成開始] --> B{LSP経由?}
    B -->|Yes| C[progress.create with CLI_DOC_WORKING]
    B -->|No| D[CLI プログレスバー更新]
    C --> E[makeDocs処理ループ]
    D --> E
    E --> F{全グローバル処理完了?}
    F -->|No| G[prog:setPercentage更新]
    G --> E
    F -->|Yes| H[プログレス完了]
```

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

### 参照テーブル一覧

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

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

### 更新テーブル一覧

なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 出力失敗 | コンソール出力が不可能な場合 | 処理は継続 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 更新間隔 | LSP経由：各処理完了時、CLI経由：約0.2秒ごと |
| 1日あたり上限 | なし |

### 配信時間帯

制限なし

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

- 機密情報は含まれない（固定メッセージと進捗率のみ）

## 備考

- LSP経由の場合、`progress.create()`で作成されたプログレスオブジェクトが使用される
- CLI経由の場合、キャリッジリターン（`\x0D`）で同じ行を上書きしてプログレス更新
- 進捗率は処理済みグローバル数/全グローバル数で計算される

---

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

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

### 推奨読解順序

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

LSP経由でドキュメント生成が呼び出された場合の処理を理解する。

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

**主要処理フロー**:
1. **156行目**: `progress.create(ws.rootUri, lang.script('CLI_DOC_WORKING'), 0)` でプログレス作成
2. **162-165行目**: `makeDocs()` 呼び出しとプログレス更新コールバック

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

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

**主要処理フロー**:
- **232-241行目**: 0.2秒ごとのプログレスバー更新ロジック

#### Step 3: ドキュメント生成ループを理解する

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

**主要処理フロー**:
- **286-289行目**: 各グローバル変数の処理とコールバック呼び出し

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

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

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

```
LSP経由:
doc.makeDoc() [init.lua:142]
    │
    ├─ progress.create(CLI_DOC_WORKING) [init.lua:156]
    │
    └─ dirty_export.makeDocs() [init.lua:162]
           │
           └─ callback(i, max) [init.lua:162-165]
                  ├─ prog:setMessage()
                  └─ prog:setPercentage()

CLI経由:
doc.runCLI() [init.lua:176]
    │
    └─ dirty_export.makeDocs() [init.lua:231]
           │
           └─ callback(i, max) [init.lua:232-241]
                  └─ io.write(プログレスバー)
```

### データフロー図

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

グローバル変数 ─────▶ makeDocs() ───▶ documentObject()
       │                    │
       │                    ▼
       │              callback(i, max)
       │                    │
       ▼                    ▼
  globals配列 ────▶ 進捗率計算 ────▶ プログレス表示
                        (i/max * 100)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| init.lua | `script/cli/doc/init.lua` | ソース | ドキュメント生成CLI/LSP処理 |
| export.lua | `script/cli/doc/export.lua` | ソース | ドキュメント生成コア処理 |
| progress.lua | `script/progress.lua` | ソース | LSPプログレス管理 |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージ定義 |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
