# バッチ設計書 14-doom ci lint-commits

## 概要

本ドキュメントは、Doom Emacsのコミットメッセージ検証コマンド「doom ci lint-commits」のバッチ設計書です。指定されたコミット範囲のコミットメッセージをConventional Commits規約に基づいて検証します。

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

doom ci lint-commitsは、Gitコミット履歴を遡り、複数のコミットメッセージを一括で検証するコマンドです。

**業務上の目的・背景**：オープンソースプロジェクトでは、多数のコントリビューターからのコミットが混在するため、コミットメッセージの形式を統一することが重要です。本コマンドは、CIパイプラインでの自動チェックや、PRマージ前のレビューに使用され、プロジェクトの履歴品質を維持します。Conventional Commitsに準拠した形式（type(scope): summary）を強制し、コミットタイプ、スコープ、サマリーの各要素を詳細に検証します。

**バッチの実行タイミング**：手動実行またはCI自動実行。プルリクエストのチェック、ブランチマージ前の検証などで使用されます。

**主要な処理内容**：
1. Git logからコミット範囲を取得
2. 各コミットメッセージをパース（type, scope, summary, body, trailers）
3. コミットルールに基づく検証（15+のルール）
4. 警告・エラーの集計と報告

**前後の処理との関連**：CI環境ではdoom ci hook commit-msg（単一コミット検証）と併用されます。本コマンドは複数コミットの一括検証に特化しています。

**影響範囲**：読み取り専用の検証コマンドであり、リポジトリに変更を加えません。検証失敗時は非ゼロの終了コードを返します。

## バッチ種別

品質検証 / リント

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Gitリポジトリ内 | カレントディレクトリがGitリポジトリ内であること |
| 有効なコミット範囲 | FROM..TO形式で指定されたコミットが存在すること |

### 実行可否判定

指定されたコミット範囲が存在しない場合はエラーとなります。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| from | String | Yes | - | 検証開始コミット（SHA/ref） |
| to | String | No | {from}~1 | 検証終了コミット（省略時はfromの直前） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Git履歴 | git log | FROM...TO範囲のコミットメッセージ |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. コミット範囲の取得
   └─ git log {from}...{to}
2. コミットメッセージの抽出
   └─ 各コミットのSHAとメッセージ本文を取得
3. 各コミットの検証
   └─ doom-ci--parse-commitでパース
   └─ doom-ci-commit-rulesに基づく検証
4. 検証ルールの適用
   └─ fixup!/squash!コミットのスキップ
   └─ サブジェクト長チェック（10-72文字）
   └─ コミットタイプの検証
   └─ スコープの検証
   └─ 本文の72文字制限
   └─ BREAKING CHANGEの整合性
   └─ トレーラーの検証
5. 結果の集計と出力
   └─ 警告数・失敗数の表示
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[git logでコミット取得]
    B --> C[コミットリスト作成]
    C --> D{コミットあり?}
    D -->|No| E[終了]
    D -->|Yes| F[次のコミットを取得]
    F --> G[コミットメッセージをパース]
    G --> H[検証ルール適用]
    H --> I{fixup!/squash!?}
    I -->|Yes| J[スキップ]
    I -->|No| K[各ルールを実行]
    K --> L[警告/エラーを記録]
    J --> M{次のコミット?}
    L --> M
    M -->|Yes| F
    M -->|No| N[結果サマリー出力]
    N --> O{エラーあり?}
    O -->|Yes| P[終了コード1]
    O -->|No| E
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | fail! | サブジェクトが10文字未満 | より詳細なコミットメッセージを記述 |
| - | fail! | サブジェクトが72文字超過 | メッセージを短縮 |
| - | fail! | 不正なコミットタイプ | 有効なタイプを使用（feat, fix, docs等） |
| - | fail! | 不正なスコープ | 有効なスコープを使用 |
| - | fail! | 本文が72文字制限超過 | 本文を改行で分割 |
| - | fail! | BREAKING CHANGE不整合 | !とBREAKING CHANGE:の整合性を確保 |
| - | fail! | 不正なトレーラー形式 | トレーラー形式を修正 |

### リトライ仕様

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

### 障害時対応

検証失敗時は、出力されるエラーメッセージに従ってコミットメッセージを修正してください。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数十〜数百コミット |
| 目標処理時間 | 数秒 |
| メモリ使用量上限 | コミット数に比例 |

## 排他制御

排他制御は不要です。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 検証開始時 | "Linting X commits..." |
| 進捗ログ | 各コミット検証時 | コミットSHAとサブジェクト |
| 警告ログ | 警告発生時 | 警告内容 |
| エラーログ | エラー発生時 | エラー内容 |
| 終了ログ | 検証終了時 | 警告数・失敗数のサマリー |

## 監視・アラート

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

## 備考

- 有効なコミットタイプ：bump, dev, docs, feat, fix, merge, nit, perf, refactor, release, revert, test, tweak
- スコープレスタイプ（bump, merge, release, revert）はスコープをコロン後に記述
- 詳細なコンベンションはhttps://discourse.doomemacs.org/git-conventionsを参照
- 将来的には`doom lint commits`に移行予定（TODOコメントあり）
