# バッチ設計書 14---check

## 概要

本ドキュメントは、診断レポートを生成するCLIコマンド `--check` のバッチ設計書です。

### 本バッチの処理概要

このCLIコマンドは、指定されたワークスペースに対してLua言語サーバーの診断機能を実行し、コードの問題点（エラー、警告、ヒント等）をレポートとして出力します。CI/CDパイプラインやコード品質チェックの自動化に使用されます。

**業務上の目的・背景**：開発チームがLuaコードの品質を継続的に監視・改善するためには、IDE外でも診断を実行できる必要があります。このコマンドにより、プルリクエスト時の自動チェック、ビルドパイプラインでの品質ゲート、大規模コードベースの一括診断などが可能になります。マルチスレッド対応により、大規模プロジェクトでも効率的な診断が可能です。

**バッチの実行タイミング**：CI/CDパイプライン実行時、手動での品質チェック時、プルリクエストの検証時などに実行されます。

**主要な処理内容**：
1. コマンドライン引数の解析と設定の取得
2. マルチスレッド実行のためのワーカープロセス起動
3. 各ワーカーで診断処理を並列実行
4. ワーカーからの結果収集とマージ
5. 結果のフォーマット（JSON/Pretty）と出力

**前後の処理との関連**：CI/CDパイプラインの一部として実行されることが多く、テストや静的解析と組み合わせて使用されます。失敗時（診断エラーが見つかった場合）は非ゼロの終了コードを返し、パイプラインを停止させることができます。

**影響範囲**：指定されたワークスペース内のLuaファイル全体が解析対象となります。

## バッチ種別

診断レポート生成・静的解析

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動/CI/CD） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 手動 / CI/CDパイプライン |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| lua-language-server実行可能ファイルが存在 | CLIを実行するための本体 |
| 有効なワークスペースパスの指定 | 診断対象のディレクトリが存在すること |

### 実行可否判定

`--check` オプションが指定されている場合、main.luaからcli/init.luaを経由して診断モードで起動します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --check | string | Yes | - | 診断対象のワークスペースパス |
| --checklevel | string | No | Warning | 出力する診断の最小レベル（Error/Warning/Information/Hint） |
| --check_format | string | No | pretty | 出力形式（json/pretty） |
| --check_out_path | string | No | LOGPATH/check.json | JSON出力ファイルのパス |
| --num_threads | number | No | 1 | 並列実行するスレッド数 |
| --quiet | boolean | No | false | 進捗表示を抑制 |
| --logpath | string | No | ./log | ログファイルの出力先 |
| --configpath | string | No | - | 設定ファイルのパス |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| ワークスペース内Luaファイル | .luaファイル | 診断対象のソースコード |
| .luarc.json / .luarc.lua | 設定ファイル | プロジェクト固有の設定 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト（pretty形式時） | 人間可読な診断結果 |
| check.json | JSON | 機械可読な診断結果 |
| 終了コード | 整数 | 0: 診断パス、1: 診断エラーあり |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | check.json（デフォルト）または--check_out_pathで指定 |
| 出力先 | LOGPATH または指定パス |
| 文字コード | UTF-8 |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. CLI引数の解析
   └─ main.luaでグローバル変数CHECKに値を設定

2. 診断モード判定
   └─ cli/init.luaでCHECKが設定されているか確認

3. cli/check.lua:runCLI()の呼び出し
   └─ 実行可能ファイルパスの取得
   └─ スレッド数の決定

4. ワーカープロセスの起動
   └─ NUM_THREADS個のサブプロセスを起動
   └─ 各ワーカーに--check_workerオプションを付与

5. 各ワーカーでの診断実行
   └─ cli/check_worker.luaが実際の診断を実行
   └─ 部分的な結果をファイルに出力

6. 結果の収集とマージ
   └─ 各ワーカーの出力ファイルを読み込み
   └─ JSONデコードしてマージ

7. 最終結果の出力
   └─ pretty形式: 標準出力に表示
   └─ json形式: ファイルに保存

8. 終了コードの返却
   └─ 診断エラーなし: 0
   └─ 診断エラーあり: 1
```

### フローチャート

```mermaid
flowchart TD
    A[コマンド実行] --> B[引数解析]
    B --> C[CHECK設定確認]
    C --> D[runCLI呼び出し]
    D --> E{マルチスレッド?}
    E -->|No| F[単一ワーカー実行]
    E -->|Yes| G[複数ワーカー起動]
    G --> H[各ワーカーで診断]
    F --> H
    H --> I[結果収集]
    I --> J{format?}
    J -->|pretty| K[標準出力に表示]
    J -->|json| L[JSONファイル保存]
    K --> M{診断エラー?}
    L --> M
    M -->|あり| N[終了コード 1]
    M -->|なし| O[終了コード 0]
```

## データベース操作仕様

### 操作別データベース影響一覧

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | データベースは使用しない |

### テーブル別操作詳細

データベース操作は行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | パス不正 | 指定されたワークスペースが存在しない | 有効なパスを指定する |
| - | 型エラー | --checkの値が文字列でない | 正しい形式で指定する |
| - | プロセス起動失敗 | ワーカープロセスの起動に失敗 | システムリソースを確認 |

### リトライ仕様

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

### 障害時対応

診断処理が失敗した場合、エラーメッセージを出力して非ゼロの終了コードを返します。

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（読み取り専用処理） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数千〜数万ファイル |
| 目標処理時間 | プロジェクトサイズに依存 |
| メモリ使用量上限 | ワーカー数に応じて増加 |

## 排他制御

マルチスレッド実行時、各ワーカーは独立した一時ファイルに出力するため、ファイル競合は発生しません。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗表示 | ワーカー起動時 | 「Using X workers」メッセージ |
| 結果サマリ | 処理完了時 | 診断件数と出力先 |
| エラーログ | エラー発生時 | プロセス起動エラー等 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 診断エラー数 | CI/CDで設定 | CI/CDシステム |

## 備考

- このコマンドは `script/cli/check.lua` と `script/cli/check_worker.lua` で実装されています
- マルチスレッド実行時は各ワーカーが `--check_worker` オプションで起動されます
- 結果ファイルは `check-partial-{threadId}.json` という名前で一時保存されます
- `--quiet` オプションで進捗表示を抑制できます
- `--check_format=pretty` の場合、結果は標準出力に表示されます
- 終了コードによりCI/CDパイプラインでの成功/失敗判定が可能です
