# 通知設計書 76-CLI_CHECK_ERROR_TYPE

## 概要

本ドキュメントは、Lua Language Serverにおける `CLI_CHECK_ERROR_TYPE` 通知の設計を記述する。この通知は、CLIでのcheck引数の型が不正な場合に表示されるエラーメッセージとして使用される。

### 本通知の処理概要

この通知は、コマンドラインから診断チェック機能を実行する際に、`--check` または `--check_worker` 引数が文字列型でない場合に表示されるエラーメッセージである。

**業務上の目的・背景**：Lua Language Serverはコマンドラインから診断チェックを実行する機能を提供している。`--check` 引数にはチェック対象のディレクトリパスを文字列で指定する必要があるが、誤った型の値が渡された場合にユーザーに明確なエラーメッセージを表示することで、問題の原因特定と解決を支援する。

**通知の送信タイミング**：CLIモードでcheck機能を実行し、CHECK_WORKER変数が文字列型でない場合に即座に表示される。

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

**通知内容の概要**：「check は文字列でなければなりませんが、{実際の型} が指定されました」というエラーメッセージ。

**期待されるアクション**：ユーザーはコマンドライン引数を確認し、正しい文字列値を指定して再実行する。

## 通知種別

CLI出力（標準出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（print関数） |
| 優先度 | 高（エラー） |
| リトライ | なし（早期終了） |

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

標準出力（stdout）に直接出力される。

## 通知テンプレート

### CLI出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | stdout |
| 形式 | プレーンテキスト |

### 本文テンプレート

```
日本語: check は文字列でなければなりませんが、{型名} が指定されました
英語: The argument of CHECK must be a string, but got {}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| {} | 渡された値の型名 | type(CHECK_WORKER) | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| CLI実行 | check_worker.runCLI() | type(CHECK_WORKER) ~= 'string' | check引数が文字列でない |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 正常な引数 | CHECK_WORKERが文字列の場合、このエラーは表示されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[CLI実行開始] --> B[runCLI呼び出し]
    B --> C{CHECK_WORKERの型チェック}
    C -->|string以外| D[CLI_CHECK_ERROR_TYPE表示]
    D --> E[早期終了]
    C -->|string| F[正常処理継続]
```

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

### 参照テーブル一覧

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

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

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 型エラー | CHECK_WORKERが文字列でない | エラーメッセージ表示後に早期終了 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- 型情報のみを表示するため、機密情報の漏洩リスクは低い
- 入力値の内容自体は表示されない

## 備考

- このエラーは処理の早い段階で検出されるため、他のエラーよりも優先的に表示される
- CI/CD環境での使用を考慮し、明確なエラーメッセージを提供する

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: `{}` はテンプレート変数のプレースホルダーとして使用される。

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

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

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

**主要処理フロー**:
1. **178行目**: runCLI関数の開始
2. **185-188行目**: CHECK_WORKERの型チェックとCLI_CHECK_ERROR_TYPEの使用箇所
3. **186行目**: type(CHECK_WORKER)の結果を表示

#### Step 3: CLIエントリを理解する

CLIモードの起動処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | check.lua | `script/cli/check.lua` | ワーカー起動処理 |

**主要処理フロー**:
- マルチスレッド対応のワーカー起動
- check_worker.luaへの処理委譲

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

```
CLI起動 (main.lua)
    │
    └─ check_worker.runCLI() (check_worker.lua:178)
           │
           ├─ lang(LOCALE) - ロケール設定
           │
           ├─ type(CHECK_WORKER) チェック
           │      │
           │      └─ string以外の場合
           │             │
           │             └─ print(lang.script('CLI_CHECK_ERROR_TYPE', type(CHECK_WORKER)))
           │                    │
           │                    └─ return（早期終了）
           │
           └─ string の場合 → 正常処理継続
```

### データフロー図

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

コマンドライン ───▶ CHECK_WORKER変数設定 ───▶ 型チェック
引数                       │                        │
                           │                        ├─ string以外
                           │                        │    │
                           │                        │    └─▶ CLI_CHECK_ERROR_TYPE
                           │                        │              │
                           │                        │              └─▶ print() → 終了
                           │                        │
                           │                        └─ string ───▶ 正常処理
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| check_worker.lua | `script/cli/check_worker.lua` | ソース | CLIチェック処理のワーカー |
| check.lua | `script/cli/check.lua` | ソース | CLIチェック処理のエントリ |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージ定義 |
| language.lua | `script/language.lua` | ソース | ローカライズ処理 |
