# 通知設計書 78-CLI_CHECK_ERROR_LEVEL

## 概要

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

### 本通知の処理概要

この通知は、コマンドラインから診断チェック機能を実行する際に、`--checklevel` 引数で指定された診断レベルが有効な値でない場合に表示されるエラーメッセージである。

**業務上の目的・背景**：Lua Language Serverの診断機能では、診断の重要度レベル（Error、Warning、Information、Hint）を指定して、特定レベル以上の問題のみをレポートすることができる。無効なレベルが指定された場合、有効な選択肢を示すエラーメッセージを表示することで、ユーザーの問題解決を支援する。

**通知の送信タイミング**：CLIモードでcheck機能を実行し、CHECKLEVEL変数が有効な診断レベル（Error、Warning、Information、Hint）のいずれでもない場合に表示される。

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

**通知内容の概要**：「checklevel は次のいずれかである必要があります：{有効なレベル一覧}」というエラーメッセージ。

**期待されるアクション**：ユーザーは有効なレベル（Error、Warning、Information、Hint）のいずれかを指定して再実行する。

## 通知種別

CLI出力（標準出力）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### CLI出力の場合

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

### 本文テンプレート

```
日本語: checklevel は次のいずれかである必要があります：{}
英語: Checklevel must be one of: {}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| {} | 有効なレベル一覧（カンマ区切り） | 'Error, Warning, Information, Hint' | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| CLI実行 | check_worker.runCLI() | CHECKLEVEL存在かつdefine.DiagnosticSeverity[CHECKLEVEL]がnil | 無効なチェックレベル |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 有効なレベル | CHECKLEVELが未指定またはError/Warning/Information/Hintのいずれか |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[CLI実行開始] --> B[runCLI呼び出し]
    B --> C[URI変換成功]
    C --> D{CHECKLEVEL存在?}
    D -->|No| E[デフォルトレベル使用]
    D -->|Yes| F{有効なレベル?}
    F -->|No| G[CLI_CHECK_ERROR_LEVEL表示]
    G --> H[早期終了]
    F -->|Yes| I[指定レベル使用]
    E --> J[正常処理継続]
    I --> J
```

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

### 参照テーブル一覧

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

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

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| レベル無効 | CHECKLEVELがDiagnosticSeverityに存在しない | エラーメッセージ表示後に早期終了 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- 有効なレベル一覧のみを表示するため、機密情報の漏洩リスクはない

## 備考

- デフォルトのチェックレベルはWarning
- Error > Warning > Information > Hint の順で重要度が高い

---

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

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

### 推奨読解順序

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

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

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

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

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

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

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

**主要処理フロー**:
1. **198-200行目**: CHECKLEVELの検証
2. **199行目**: define.DiagnosticSeverity[CHECKLEVEL]でレベル検証
3. **199行目**: CLI_CHECK_ERROR_LEVELの使用箇所

#### Step 3: 診断レベル定義を理解する

有効な診断レベルの定義を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | define.lua | `script/proto/define.lua` | DiagnosticSeverityの定義 |

**主要処理フロー**:
- Error = 1
- Warning = 2
- Information = 3
- Hint = 4

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

```
CLI起動 (main.lua)
    │
    └─ check_worker.runCLI() (check_worker.lua:178)
           │
           ├─ 型チェック通過
           │
           ├─ URI変換成功
           │
           └─ CHECKLEVEL検証
                  │
                  ├─ CHECKLEVEL存在 and define.DiagnosticSeverity[CHECKLEVEL] == nil
                  │      │
                  │      └─ print(lang.script('CLI_CHECK_ERROR_LEVEL', 'Error, Warning, Information, Hint'))
                  │             │
                  │             └─ return（早期終了）
                  │
                  └─ 有効 or 未指定 → 正常処理継続
```

### データフロー図

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

--checklevel ───▶ DiagnosticSeverity参照 ───▶ レベル検証
引数                        │                        │
                           │                        ├─ 無効なレベル
                           │                        │    │
                           │                        │    └─▶ CLI_CHECK_ERROR_LEVEL
                           │                        │              │
                           │                        │              └─▶ print() → 終了
                           │                        │
                           │                        └─ 有効 ───▶ checkLevel設定
```

### 関連ファイル一覧

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