# バッチ設計書 15-doom ci hook commit-msg

## 概要

本ドキュメントは、Doom Emacsのgit commit-msgフックコマンド「doom ci hook commit-msg」のバッチ設計書です。Gitのcommit-msgフックとして呼び出され、コミットメッセージの形式をリアルタイムで検証します。

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

doom ci hook commit-msgは、git commitコマンド実行時に自動的に呼び出され、コミットメッセージがConventional Commits規約に準拠しているかを検証するコマンドです。

**業務上の目的・背景**：コミットメッセージの品質をコミット時点でチェックすることで、後からのrebaseやamendを減らし、開発効率を向上させます。本コマンドはgit commit-msgフックとして機能し、不正なコミットメッセージを持つコミットの作成を防止します。開発者は即座にフィードバックを受け取り、メッセージを修正できます。

**バッチの実行タイミング**：git commit実行時（自動）。doom ci deploy-hooks（No.13）でフックがインストールされている場合に自動実行されます。

**主要な処理内容**：
1. コミットメッセージファイルの読み込み
2. Gitコメント（# で始まる行）の除去
3. コミットメッセージのパース
4. Conventional Commits規約に基づく検証
5. 検証結果の出力と終了コードの返却

**前後の処理との関連**：doom ci deploy-hooks（No.13）でフックスクリプトとしてインストールされ、git commit時に自動実行されます。検証失敗時はコミットが中断されます。

**影響範囲**：コミットメッセージの検証のみを行い、リポジトリに変更を加えません。検証失敗時はコミットプロセスを中断します。

## バッチ種別

品質検証 / Gitフック

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | git commit時（自動） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | git commit-msgフック |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| フックインストール済み | doom ci deploy-hooksでフックがインストールされていること |
| コミットメッセージファイル | $1引数としてコミットメッセージファイルのパスが渡されること |

### 実行可否判定

コミットメッセージファイルが存在し、読み取り可能であること。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| file | String | Yes | - | コミットメッセージファイルのパス |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| コミットメッセージファイル | テキストファイル | .git/COMMIT_EDITMSG等 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 検証結果（色なし、--no-color） |
| 終了コード | 数値 | 0=成功、1=検証失敗 |

### 出力ファイル仕様

ファイル出力はありません。

## 処理フロー

### 処理シーケンス

```
1. コミットメッセージファイルの読み込み
   └─ insert-file-contents file
2. Gitコメントの除去
   └─ "# Please enter the commit message"以降を削除
3. コミットメッセージのパース
   └─ doom-ci--parse-commitでtype, scope, summary, body, trailersを抽出
4. 検証ルールの適用
   └─ doom-ci-commit-rulesの全ルールを実行
5. 結果の出力
   └─ 警告・エラーの表示
6. 終了コードの返却
   └─ 失敗時はexit! 1でコミットを中断
```

### フローチャート

```mermaid
flowchart TD
    A[git commit実行] --> B[commit-msgフック起動]
    B --> C[doom ci hook commit-msg呼び出し]
    C --> D[コミットメッセージ読み込み]
    D --> E[Gitコメント除去]
    E --> F[メッセージパース]
    F --> G[検証ルール適用]
    G --> H{検証成功?}
    H -->|Yes| I[終了コード0]
    H -->|No| J[エラーメッセージ出力]
    J --> K[終了コード1]
    I --> L[コミット続行]
    K --> M[コミット中断]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | fail! | サブジェクトが10文字未満 | より詳細なコミットメッセージを記述 |
| - | fail! | サブジェクトが72文字超過 | メッセージを短縮 |
| - | fail! | 不正なコミットタイプ | 有効なタイプを使用 |
| - | fail! | 不正なスコープ | 有効なスコープを使用 |
| - | fail! | 本文が72文字制限超過 | 本文を改行で分割 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | N/A |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

検証失敗時はコミットメッセージを編集して再度git commitを実行してください。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1コミット |
| 目標処理時間 | 1秒未満 |
| メモリ使用量上限 | 最小限 |

## 排他制御

排他制御は不要です。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 検証開始時 | "Linting commit..." |
| エラーログ | エラー発生時 | 各検証ルールのエラーメッセージ |
| 終了ログ | 検証終了時 | "There were no issues!" または失敗数 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| N/A | N/A | N/A |

## 備考

- echo-msg引数がtrueで呼び出され、エラー時に元のコミットメッセージを表示します
- コミットメッセージファイルからは"# Please enter the commit message"以降が自動的に除去されます
- 将来的には`doom lint hook:commit-msg`に移行予定（TODOコメントあり）
- フックスクリプトは`--no-color`オプション付きで呼び出されます
