# バッチ設計書 11-ensure-no-files-changed

## 概要

本ドキュメントは、Prettierプロジェクトにおける `ensure-no-files-changed.js` バッチの設計仕様を定義します。このバッチは、git diffコマンドを使用してワーキングディレクトリに変更されたファイルがないことを確認するCI用検証スクリプトです。

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

このバッチは、CI/CD環境において、自動生成ファイルやビルド成果物が正しくコミットされているかを検証するために使用されます。git diffコマンドを実行し、ワーキングディレクトリに未コミットの変更がないことを確認します。

**業務上の目的・背景**：CIパイプラインにおいて、自動生成されるファイル（型定義、ビルド成果物など）がリポジトリに正しくコミットされているかを検証する必要があります。開発者がローカルでビルドや生成スクリプトを実行した後、変更をコミットし忘れた場合にCIで検出することで、ビルドの再現性と一貫性を保証します。

**バッチの実行タイミング**：CIパイプライン実行時（プルリクエスト作成時、プッシュ時）。ビルドや自動生成スクリプトの実行後に呼び出されます。

**主要な処理内容**：
1. `git diff --name-only`コマンドを実行して変更されたファイル一覧を取得
2. 変更ファイルがない場合は成功メッセージを出力して正常終了
3. 変更ファイルがある場合はファイル一覧を表示
4. `git diff --exit-code`を実行して詳細な差分を表示し、エラーコードで終了

**前後の処理との関連**：このバッチは通常、ビルドバッチ（build.js）や自動生成バッチ（generate-flow-estree-type-definition.js等）の後に実行されます。前段のバッチで生成されたファイルが既存のコミット済みファイルと一致することを検証します。

**影響範囲**：このバッチ自体はファイルの変更を行いません。CIパイプラインの成否判定に影響を与え、変更があった場合はビルドを失敗させます。

## バッチ種別

検証・バリデーション

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| gitリポジトリ | 実行ディレクトリがgitリポジトリ内であること |
| Node.js環境 | Node.js実行環境が利用可能であること |
| nano-spawn | 依存パッケージがインストール済みであること |

### 実行可否判定

常に実行可能。gitリポジトリ内であれば実行できます。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | コマンドライン引数は受け取りません |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| ワーキングディレクトリ | ファイルシステム | gitで管理されているファイル群 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 検証結果メッセージ |
| 終了コード | 数値 | 0=成功、1以上=変更あり |

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. getChangedFiles関数の実行
   └─ git diff --name-onlyを実行し、変更されたファイル名を取得

2. 変更ファイルの有無チェック
   └─ 配列の長さが0かどうかを判定

3. 結果出力
   └─ 変更なし: 成功メッセージを出力して終了
   └─ 変更あり: 変更ファイル一覧を表示

4. 詳細差分表示（変更ありの場合）
   └─ git diff --exit-codeを実行
   └─ 差分を標準出力に表示し、終了コードを設定
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[git diff --name-only実行]
    B --> C{変更ファイルあり?}
    C -->|なし| D[成功メッセージ出力]
    D --> E[正常終了 exit 0]
    C -->|あり| F[変更ファイル一覧表示]
    F --> G[git diff --exit-code実行]
    G --> H[差分詳細表示]
    H --> I[エラー終了 exit 1]
```

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

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

データベース操作はありません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | 変更検出エラー | ワーキングディレクトリに未コミットの変更がある | 変更をコミットするか、不要な変更を取り消す |
| 128 | git実行エラー | gitコマンドの実行に失敗 | gitがインストールされているか確認 |

### リトライ仕様

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

### 障害時対応

1. 変更が検出された場合は、表示された差分を確認
2. 自動生成ファイルの場合は、対応する生成スクリプトを再実行してコミット
3. 意図しない変更の場合は `git checkout` で変更を取り消す

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回のgit diff実行 |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | 制限なし |

## 排他制御

同時実行の制限はありません。ただし、他のプロセスがファイルを変更中の場合、正確な検出ができない可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 成功ログ | 変更なし時 | "No files changed." |
| 警告ログ | 変更あり時 | 変更ファイル数と一覧 |
| 差分ログ | 変更あり時 | git diffの出力 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | CIパイプラインの失敗通知 |

## 備考

- このスクリプトはshebang (`#!/usr/bin/env node`) により直接実行可能です
- nano-spawnパッケージを使用してgitコマンドを非同期実行しています
- ES Modules形式で実装されています
