# 通知設計書 79-CLI_CHECK_INITING

## 概要

本ドキュメントは、Lua Language Serverにおける `CLI_CHECK_INITING` 通知の設計を記述する。この通知は、CLIでの診断チェック機能の初期化中に表示される進行状況メッセージとして使用される。

### 本通知の処理概要

この通知は、コマンドラインから診断チェック機能を実行する際に、ワークスペースの初期化処理が開始されたことをユーザーに知らせるメッセージである。

**業務上の目的・背景**：Lua Language Serverの診断チェック機能は、ワークスペース内のすべてのLuaファイルを解析するため、初期化に時間がかかることがある。ユーザーに処理が進行中であることを示すことで、待機時間中の不安を軽減し、ユーザーエクスペリエンスを向上させる。

**通知の送信タイミング**：CLIモードでcheck機能を実行し、引数の検証が完了した後、ワークスペースの初期化処理（provider.updateConfig、ws.awaitReady）が開始される前に表示される。

**通知の受信者**：CLIを使用してLua Language Serverの診断機能を実行している開発者またはCI/CDシステム。

**通知内容の概要**：「初期化中...」という進行状況メッセージ。

**期待されるアクション**：ユーザーは初期化処理が完了するまで待機する。特別なアクションは不要。

## 通知種別

CLI出力（標準出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（io.write関数） |
| 優先度 | 通常（情報） |
| リトライ | なし |

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

標準出力（stdout）に直接出力される。io.writeを使用するため、改行なしで出力される。

## 通知テンプレート

### CLI出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | stdout |
| 形式 | プレーンテキスト（改行なし） |

### 本文テンプレート

```
日本語: 初期化中...
英語: Initializing ...
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| - | テンプレート変数なし | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| CLI実行 | check_worker.runCLI() | quiet == false | 初期化開始時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| quiet モード | quiet変数がtrueの場合、メッセージは表示されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[CLI実行開始] --> B[runCLI呼び出し]
    B --> C[型チェック通過]
    C --> D[URI変換成功]
    D --> E[レベル検証成功]
    E --> F{quiet?}
    F -->|Yes| G[メッセージ表示スキップ]
    F -->|No| H[CLI_CHECK_INITING表示]
    G --> I[provider.updateConfig]
    H --> I
    I --> J[ws.awaitReady]
    J --> K[診断処理開始]
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない。

### テーブル別参照項目詳細

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 出力エラー | stdout への書き込み失敗 | Luaランタイムエラー |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし

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

- 固定メッセージのため、機密情報の漏洩リスクはない
- ユーザー入力は含まれない

## 備考

- io.writeを使用するため、出力に改行が含まれない
- 後続の進行状況表示（CLI_CHECK_PROGRESS）で同じ行が上書きされることを想定
- QUIET環境変数とquiet引数の両方で抑止可能

---

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

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

### 推奨読解順序

#### Step 1: データ構造を理解する

まず、通知で使用されるローカライズ文字列の定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | script.lua | `locale/ja-jp/script.lua` | CLI_CHECK_INITINGの日本語定義（671-672行目）を確認 |
| 1-2 | script.lua | `locale/en-us/script.lua` | CLI_CHECK_INITINGの英語定義（670-671行目）を確認 |

**読解のコツ**: このメッセージにはテンプレート変数がなく、固定文字列である。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | check_worker.lua | `script/cli/check_worker.lua` | runCLI関数（178-293行目） |

**主要処理フロー**:
1. **231行目**: quietフラグのチェック
2. **232行目**: io.write(lang.script('CLI_CHECK_INITING'))の実行
3. **235行目**: provider.updateConfig(rootUri)で設定更新
4. **237行目**: ws.awaitReady(rootUri)でワークスペース準備待機

#### Step 3: 出力制御を理解する

quietモードの制御を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | check_worker.lua | `script/cli/check_worker.lua` | quiet変数の定義と使用 |

**主要処理フロー**:
- quiet変数がfalseの場合のみメッセージが表示される
- QUIETとCHECK_FORMATの設定により出力が制御される

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

```
CLI起動 (main.lua)
    |
    +-- check_worker.runCLI() (check_worker.lua:178)
           |
           +-- 型チェック通過 (185-188行目)
           |
           +-- URI変換成功 (190-195行目)
           |
           +-- レベル検証成功 (198-200行目)
           |
           +-- if not quiet then (231行目)
           |      |
           |      +-- io.write(lang.script('CLI_CHECK_INITING')) (232行目)
           |
           +-- provider.updateConfig(rootUri) (235行目)
           |
           +-- ws.awaitReady(rootUri) (237行目)
           |
           +-- 診断処理開始 (246-261行目)
```

### データフロー図

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

CLI実行 ───────────▶ 引数検証成功
                           |
                           v
                     quiet チェック ─────▶ quiet == true → 出力なし
                           |
                           | quiet == false
                           v
                     lang.script() ───▶ ロケールから
                           |            メッセージ取得
                           v
                     io.write() ───────▶ stdout: "初期化中..."
                           |
                           v
                     ワークスペース初期化
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| check_worker.lua | `script/cli/check_worker.lua` | ソース | CLIチェック処理のワーカー |
| provider.lua | `script/provider/provider.lua` | ソース | 設定更新処理 |
| workspace.lua | `script/workspace/workspace.lua` | ソース | ワークスペース管理 |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージ定義 |
