# バッチ設計書 35-make check

## 概要

本ドキュメントは、mrubyプロジェクトにおけるMakeターゲット `make check` のバッチ設計書である。prek（pre-commit）フックを全ファイルに対して実行する品質管理コマンドについて記述する。

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

`make check` は、Makefileで定義された品質管理用ターゲットであり、prek（pre-commitフレームワーク）を使用して全ファイルに対するリンティング・フォーマットチェック等の品質検査を実行する。

**業務上の目的・背景**：コードベース全体に対してpre-commitフックで定義された品質チェック（コードフォーマット、リンティング、静的解析等）を一括実行するために使用される。コミット前の品質保証やCIパイプラインでの品質ゲートとして機能する。

**バッチの実行タイミング**：開発者が手動で任意のタイミングで実行する。特にコミット前の品質確認やプルリクエスト作成前の最終チェックとして使用される。

**主要な処理内容**：
1. prekコマンドの存在チェック（check_pre_commit依存ターゲット）
2. `$(PRE_COMMIT) run --all-files` の実行（= `prek run --all-files`）
3. .pre-commit-config.yamlで定義された全フックをリポジトリ内の全ファイルに対して実行

**前後の処理との関連**：本タスクは独立して実行可能である。No.28 `rake checkinstall` でpre-commitフックがインストールされていることが望ましい。No.36 `make composecheck` はDocker環境で同等の処理を実行するバリエーションである。

**影響範囲**：ファイルの内容を直接変更する可能性がある（自動フォーマット等のフックが含まれる場合）。チェック結果は標準出力に表示される。

## バッチ種別

品質管理（コード検査）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動（開発者によるコマンド実行） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| prek | prekコマンドが利用可能であること（check_pre_commitで検証） |
| .pre-commit-config.yaml | プロジェクトルートにpre-commit設定ファイルが存在すること |
| Git | Gitリポジトリとして初期化されていること |

### 実行可否判定

Makefileの `check_pre_commit` ターゲットが先に実行され、`command -v prek` でprekコマンドの存在を確認する。存在しない場合は「Error: prek is not installed or not in PATH.」メッセージを出力して終了する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| PRE_COMMIT | Makefile変数 | No | prek | 使用するpre-commitコマンド |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Makefile | Make | ターゲット定義 |
| .pre-commit-config.yaml | YAML | pre-commitフックの設定 |
| リポジトリ内全ファイル | 各種 | チェック対象ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 各フックの実行結果（Passed/Failed） |

### 出力ファイル仕様

フックの種類によっては自動フォーマット等でファイルが変更される場合がある。

| 項目 | 内容 |
|-----|------|
| ファイル名 | フック依存（自動修正対象のファイル） |
| 出力先 | リポジトリ内のソースファイル |
| 文字コード | ファイル依存 |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. check_pre_commit実行
   └─ prekコマンドの存在確認
2. $(PRE_COMMIT) run --all-files実行
   └─ prek run --all-files を実行
3. 各フックの実行
   └─ .pre-commit-config.yamlで定義された全フックを順次実行
4. 結果出力
   └─ 各フックのPassed/Failed結果を標準出力に表示
```

### フローチャート

```mermaid
flowchart TD
    A[make check 開始] --> B[check_pre_commit: prekコマンド存在確認]
    B --> C{prekが存在?}
    C -->|なし| D[エラー出力・終了]
    C -->|あり| E[prek run --all-files 実行]
    E --> F[各フックを順次実行]
    F --> G{全フック成功?}
    G -->|はい| H[正常終了]
    G -->|いいえ| I[エラー出力・非0終了]
    H --> J[バッチ終了]
    I --> J
```

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

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

本バッチではデータベース操作は行わない。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | データベース操作なし |

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

該当なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | コマンド未検出 | prekコマンドがPATHに存在しない | prekをインストールする |
| 非0終了 | フック失敗 | 1つ以上のフックが失敗 | 失敗フックの出力を確認し、コードを修正する |
| 非0終了 | 設定エラー | .pre-commit-config.yamlの構文エラー | 設定ファイルを修正する |

### リトライ仕様

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

### 障害時対応

フック失敗時は、標準出力のフック結果を確認し、失敗したフックを特定する。自動フォーマットフックの場合はファイルが修正されている可能性があるため、`git diff` で変更を確認する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（データベーストランザクションなし） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | リポジトリ内全ファイル |
| 目標処理時間 | フック数・ファイル数に依存 |
| メモリ使用量上限 | システム依存 |

## 排他制御

同一リポジトリで複数の `make check` を同時実行すると、ファイルの自動修正が競合する可能性がある。同時実行は避けるべきである。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | フック実行開始時 | 各フック名 |
| 進捗ログ | フック実行中 | 各フックのPassed/Failed |
| 終了ログ | 全フック完了時 | 全体結果サマリー |
| エラーログ | フック失敗時 | 失敗詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 特に定めなし | 標準出力 |
| 失敗フック数 | 1件以上 | 標準エラー出力 |

## 備考

- Makefileでは `PRE_COMMIT = prek` と定義されており、`prek` コマンドを使用する
- `--all-files` オプションにより、Git追跡対象の全ファイルがチェック対象となる
- Rakefileにも同等の `rake check` タスクが定義されている（`sh "prek run --all-files"`）
- Makefileのコメント `## run all prek hooks against all files` がhelpターゲットで表示される
