# バッチ設計書 28-rake checkinstall

## 概要

本ドキュメントは、mrubyプロジェクトにおける `rake checkinstall` タスクのバッチ設計書である。prek（pre-commitフレームワーク）のフックをローカルリポジトリにインストールする処理を定義する。

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

`rake checkinstall` は、prek（pre-commitツール）のGitフックをローカルリポジトリの `.git/hooks/` ディレクトリにインストールするRakeタスクである。インストール後、`git commit` 時に自動的にpre-commitフックが実行されるようになる。

**業務上の目的・背景**：開発者がコミット前に自動的にコード品質チェックを実行できるようにするため、pre-commitフックをGitリポジトリにインストールする必要がある。本タスクはその初期設定を自動化する。開発環境のセットアップ手順の一環として実行される。

**バッチの実行タイミング**：手動実行。リポジトリのクローン直後や、開発環境のセットアップ時に一度だけ実行する。

**主要な処理内容**：
1. `prek install` コマンドを実行
2. .pre-commit-config.yaml の設定に基づいてフック環境をセットアップ
3. .git/hooks/ にpre-commitフックスクリプトをインストール

**前後の処理との関連**：前提としてprekツールのインストールが必要。本タスク実行後、`git commit` 時にpre-commitフックが自動実行される。`rake check` で手動チェックも可能。`rake checkupdate` でフックの更新確認が可能。

**影響範囲**：`.git/hooks/` ディレクトリに影響を与える。既存のGitフックがある場合は上書きされる可能性がある。

## バッチ種別

環境設定（フックインストール）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 初回のみ（環境セットアップ時） |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動（`rake checkinstall` コマンド実行） |

## 実行条件

### 前提条件

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

### 実行可否判定

`prek` コマンドがPATH上に存在し、Gitリポジトリ内で実行する場合に実行可能。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| .pre-commit-config.yaml | YAML | pre-commitフック設定ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| .git/hooks/pre-commit | シェルスクリプト | pre-commitフックスクリプト |
| 標準出力 | テキスト | インストール結果 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | pre-commit（Gitフック） |
| 出力先 | `.git/hooks/` |
| 文字コード | UTF-8 |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. rake checkinstall タスク開始
2. sh "prek install" を実行
   └─ .pre-commit-config.yaml を読み込み
   └─ フック環境をセットアップ
   └─ .git/hooks/ にフックスクリプトをインストール
3. rake checkinstall タスク完了
```

### フローチャート

```mermaid
flowchart TD
    A[rake checkinstall 開始] --> B[prek install 実行]
    B --> C{インストール成功?}
    C -->|Yes| D[正常終了]
    C -->|No| E[異常終了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | コマンド未検出 | prek がインストールされていない | pip/pipx等でprekをインストール |
| N/A | Gitリポジトリ不在 | .git/ ディレクトリが存在しない | Gitリポジトリとして初期化するか、正しいディレクトリで実行 |

### リトライ仕様

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

### 障害時対応

エラーメッセージに従って環境を整備し、再実行する。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回の実行 |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | prek プロセスの標準的なメモリ使用量 |

## 排他制御

同時実行は特に制限されないが、通常は一度だけ実行すれば十分。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | インストール時 | prek のインストール結果メッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| N/A | N/A | N/A（初回セットアップのため監視対象外） |

## 備考

- 本タスクは開発環境の初期セットアップ時に一度実行すればよい
- フックのインストール後は `git commit` 時に自動的にチェックが実行される
- `sh` メソッドを使用しているため、コマンドが非0で終了した場合はRakeタスクも失敗する
- 既存のGitフックがある場合の動作はprekの実装に依存する
