# バッチ設計書 32-Invoke-FormattingCheck.ps1

## 概要

本ドキュメントは、OpenConsoleプロジェクトにおけるコードフォーマットチェックスクリプト `Invoke-FormattingCheck.ps1` の設計仕様を記載する。

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

本スクリプトは、C++コードおよびXAMLファイルのフォーマットが規定のスタイルに準拠しているかを検証し、差分がある場合はエラーをスローして失敗させる。CI/CDパイプラインにおけるコード品質ゲートとして機能する。

**業務上の目的・背景**：チーム開発において、コードフォーマットの統一はコードレビューの効率化と可読性向上に不可欠である。本スクリプトはCI/CDパイプラインに組み込まれ、フォーマット違反のあるコードがマージされることを防止する自動ゲートの役割を担う。開発者が `runformat.cmd`（No.30）や `runxamlformat.cmd`（No.31）を実行し忘れた場合でも、本スクリプトがCIで検出してビルドを失敗させることで、フォーマット未適用コードの混入を防ぐ。

**バッチの実行タイミング**：CI/CDパイプラインの一部として自動実行される。プルリクエスト作成時やコミットプッシュ時にトリガーされる。

**主要な処理内容**：
1. `OpenConsole.psm1` モジュールをインポートする
2. `Invoke-CodeFormat -IgnoreXaml` を呼び出し、C++コードにclang-formatを適用する（XAMLは除外）
3. `git diff-index --quiet HEAD --` でワーキングツリーに差分がないかチェックする
4. 差分がある場合、差分ファイル一覧を出力し例外をスローする
5. `Test-XamlFormat` を呼び出し、XAMLファイルのフォーマットを検証する（ファイル変更なし）

**前後の処理との関連**：本スクリプトは `runformat.cmd`（No.30）および `runxamlformat.cmd`（No.31）で適用されるフォーマットの検証を行う。CI/CDパイプラインのビルドステップの一部として、コードのフォーマット品質を保証する。

**影響範囲**：リポジトリ内のC++ソースファイル（*.cpp, *.hpp, *.h）およびXAMLファイル（*.xaml）が検証対象。本スクリプト自体はC++ファイルの内容を変更する可能性があるが（clang-formatの適用）、変更があった場合はエラーとなる設計。XAMLファイルは `--passive` モードで検証のみ行い、変更しない。

## バッチ種別

コード整形（検証）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（CI/CDパイプライン実行時） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | CI/CDパイプライン（プルリクエスト・コミットプッシュ時） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| PowerShellが利用可能 | スクリプト実行環境としてPowerShellが必要 |
| gitが利用可能 | `git diff-index` による差分チェックに必要 |
| dotnet CLIが利用可能 | xstylerの `--passive` モード検証に必要 |
| OpenConsole.psm1が存在 | `./tools/OpenConsole.psm1` にモジュールが配置されていること |
| NuGetパッケージが利用可能 | clang-formatパッケージの復元に必要 |
| リポジトリルートから実行 | 相対パス `./tools/OpenConsole.psm1` を使用するため |

### 実行可否判定

特段の判定ロジックはない。前提条件が満たされていれば実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本スクリプトはパラメータを受け取らない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| `src/**/*.cpp, *.hpp, *.h` | C++ | clang-formatの適用対象となるC++ソースファイル |
| `**/*.xaml` | XAML | XamlStylerの検証対象となるXAMLファイル |
| `tools/packages.config` | XML | clang-formatパッケージのバージョン定義 |
| `XamlStyler.json` | JSON | XamlStylerの設定ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | フォーマット差分があるファイルの一覧（エラー時） |
| 例外 | PowerShell例外 | フォーマット違反検出時にスロー |

### 出力ファイル仕様

本スクリプトはファイル出力を目的としない。C++ファイルへの一時的なフォーマット適用が行われるが、差分がなければ変更は実質的に発生しない。

## 処理フロー

### 処理シーケンス

```
1. OpenConsole.psm1モジュールのインポート
   └─ ./tools/OpenConsole.psm1を読み込み
2. Invoke-CodeFormat -IgnoreXaml の実行
   ├─ 2-1. NuGetでclang-formatパッケージを復元
   ├─ 2-2. src配下のC++ファイルにclang-formatを適用
   └─ 2-3. XAMLフォーマットはスキップ（-IgnoreXaml）
3. git diff-index --quiet HEAD -- による差分チェック
   ├─ 戻り値0: 差分なし → 次のステップへ
   └─ 戻り値1: 差分あり → ファイル一覧出力後、例外スロー
4. Test-XamlFormat の実行
   ├─ dotnet tool restoreの実行
   ├─ git ls-filesで全XAMLファイルを列挙
   ├─ xstyler --passiveモードで検証
   ├─ 戻り値0: フォーマット準拠 → 正常終了
   └─ 戻り値1: フォーマット違反 → 例外スロー
```

### フローチャート

```mermaid
flowchart TD
    A[スクリプト開始] --> B[OpenConsole.psm1インポート]
    B --> C[Invoke-CodeFormat -IgnoreXaml]
    C --> D{git diff-index: 差分あり?}
    D -->|なし| E[Test-XamlFormat実行]
    D -->|あり| F[差分ファイル一覧出力]
    F --> G[例外スロー: code formatting bad]
    E --> H{XAML検証: 差分あり?}
    H -->|なし| I[正常終了]
    H -->|あり| J[例外スロー: Xaml formatting bad]
```

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

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

データベース操作はない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | C++フォーマット違反 | clang-format適用後にgit差分が検出された場合 | ローカルで `runformat.cmd` を実行してフォーマットを修正 |
| - | XAMLフォーマット違反 | xstyler --passiveが差分を検出した場合 | ローカルで `runxamlformat.cmd` を実行してフォーマットを修正 |
| - | モジュール読み込みエラー | OpenConsole.psm1が見つからない場合 | リポジトリルートから実行していることを確認 |

### リトライ仕様

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

### 障害時対応

フォーマット違反が検出された場合は、開発者がローカル環境で `runformat.cmd` または `runxamlformat.cmd` を実行してフォーマットを修正し、再度コミット・プッシュする。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | リポジトリ内の全C++/XAMLファイル数に依存 |
| 目標処理時間 | 特に定義なし |
| メモリ使用量上限 | 特に定義なし |

## 排他制御

CI/CDパイプラインのジョブ単位で実行されるため、同一環境での同時実行は発生しない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 差分ファイル一覧 | C++フォーマット違反検出時 | `git diff-index --name-only HEAD` の出力 |
| 例外メッセージ | フォーマット違反検出時 | "code formatting bad, run Invoke-CodeFormat on branch" または "Xaml formatting bad, run Invoke-XamlFormat on branch" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| CI/CDパイプライン結果 | 失敗 | プルリクエスト上の通知 |

## 備考

- 本スクリプトはC++フォーマットチェック時にXAMLを意図的にスキップする（`-IgnoreXaml`）。これはxstylerが変更がなくてもファイルを「touch」する特性があり、git diff-indexで誤検出されるのを防ぐためである。
- XAMLのチェックは `Test-XamlFormat` で別途 `--passive` モードを使用して、ファイルを変更せずに検証する。
- 例外メッセージ "code formatting bad, run Invoke-CodeFormat on branch" はC++フォーマット違反時のもの。
- 例外メッセージ "Xaml formatting bad, run Invoke-XamlFormat on branch" はXAMLフォーマット違反時のもの。
- ソースファイル: `build/scripts/Invoke-FormattingCheck.ps1`
