# バッチ設計書 27-rake check

## 概要

本ドキュメントは、mrubyプロジェクトにおける `rake check` タスクのバッチ設計書である。prek（pre-commit フレームワーク）を使用して、全ファイルに対して全pre-commitフックを実行する品質管理処理を定義する。

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

`rake check` は、prek（pre-commitツール）を使用してリポジトリ内の全ファイルに対して設定済みの全pre-commitフックを実行するRakeタスクである。コードの品質チェック、フォーマット検証、静的解析等を一括で行う。

**業務上の目的・背景**：コードの品質を一定水準に保つために、コミット前のフックチェックを全ファイルに対して実行する手段が必要である。CIパイプラインでの品質ゲートとして、またローカル開発時の包括的なチェックツールとして利用される。

**バッチの実行タイミング**：手動実行。コード品質の包括的なチェックが必要な場合に随時実行する。GitHub Actions（pre-commit.yml）でもPR時に自動実行される。

**主要な処理内容**：
1. `prek run --all-files` コマンドを実行
2. .pre-commit-config.yaml に定義された全フックが全ファイルに対して実行される
3. フックの結果（成功/失敗）がコンソールに出力される

**前後の処理との関連**：前提となるバッチはない。`rake checkinstall` でフックをインストールした後に使用する。`rake composecheck` はDocker環境で同様のチェックを実行するバリアント。

**影響範囲**：読み取り専用の検証処理が主だが、一部のフック（フォーマッター等）はファイルを自動修正する可能性がある。

## バッチ種別

品質管理（静的解析・フォーマットチェック）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 / PR時（CI） |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動（`rake check`）/ CI（pre-commit.yml） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| prek インストール済み | `prek` コマンドが実行可能であること |
| pre-commit設定 | `.pre-commit-config.yaml` がリポジトリルートに存在すること |
| Ruby環境 | Rakeが実行可能なRuby環境がセットアップされていること |

### 実行可否判定

`prek` コマンドがPATH上に存在し、`.pre-commit-config.yaml` が存在する場合に実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| N/A | N/A | N/A | N/A | コマンドライン引数は受け取らない |

### 入力データソース

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

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

直接的なファイル出力はないが、フォーマッター系フックがファイルを自動修正する可能性がある。

## 処理フロー

### 処理シーケンス

```
1. rake check タスク開始
2. sh "prek run --all-files" を実行
   └─ .pre-commit-config.yaml を読み込み
   └─ 定義された全フックを全ファイルに対して実行
   └─ 各フックの結果をコンソールに出力
3. 全フックが成功した場合: 正常終了（exit 0）
4. いずれかのフックが失敗した場合: 異常終了（exit非0）
```

### フローチャート

```mermaid
flowchart TD
    A[rake check 開始] --> B[prek run --all-files 実行]
    B --> C[全フックを全ファイルに対して実行]
    C --> D{全フック成功?}
    D -->|Yes| E[正常終了]
    D -->|No| F[異常終了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | コマンド未検出 | prek がインストールされていない | `rake checkinstall` でインストール |
| N/A | フック失敗 | いずれかのpre-commitフックが失敗 | エラーメッセージを確認して該当ファイルを修正 |
| N/A | 設定ファイル不在 | .pre-commit-config.yaml が存在しない | 設定ファイルを作成 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（手動で再実行） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

フック失敗時は、出力されるエラーメッセージに従って該当ファイルを修正し、再実行する。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | リポジトリ内の全ファイル |
| 目標処理時間 | フック数とファイル数に依存（数分程度） |
| メモリ使用量上限 | 各フックツールに依存 |

## 排他制御

同時実行は可能だが、フォーマッター系フックがファイルを修正する場合は競合の可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | 各フック実行時 | フック名と結果（Passed/Failed/Skipped） |
| エラーログ | フック失敗時 | 失敗したフックの詳細とエラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| N/A | N/A | N/A（手動実行 / CIで結果確認） |

## 備考

- `prek` は pre-commit のラッパーまたは互換ツール
- `--all-files` フラグにより、変更されたファイルだけでなく全ファイルが対象となる
- `sh` メソッドを使用しているため、コマンドが非0で終了した場合はRakeタスクも失敗する
- Makefile にも `make check` として同等のターゲットが定義されている（`prek run --all-files`）
