# バッチ設計書 31-runxamlformat.cmd

## 概要

本ドキュメントは、XAMLファイルに対してxstylerフォーマッターを適用するバッチスクリプト `runxamlformat.cmd` の設計仕様を記載する。

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

本バッチは、OpenConsoleプロジェクト内のXAMLファイルに対してXamlStyler（xstyler）を適用し、コードフォーマットを統一するためのラッパースクリプトである。

**業務上の目的・背景**：OpenConsoleプロジェクトでは、C++コードに対するclang-formatと同様に、XAMLファイルに対してもコードスタイルの統一が求められている。XamlStylerは.NETのdotnet toolとして提供されるXAMLフォーマッターであり、本バッチはこのツールの実行を簡略化するために存在する。開発者がコマンドラインから手軽にXAMLフォーマットを適用できるようにすることで、コードレビュー時のスタイル差分を削減し、レビュー効率を向上させる。

**バッチの実行タイミング**：開発者がXAMLファイルを変更した後の任意のタイミングで手動実行する。コミット前やプルリクエスト作成前にフォーマット統一を行う目的で使用される。

**主要な処理内容**：
1. OpenConsole.psm1モジュールをインポートする
2. Invoke-XamlFormat関数を呼び出し、gitリポジトリ内の全XAMLファイルにxstylerを適用する
3. XAMLファイルからBOM（Byte Order Mark）を除去する

**前後の処理との関連**：本バッチは開発環境セットアップバッチ（razzle.cmd）により設定される環境変数 `%OPENCON_TOOLS%` を前提とする。また、Invoke-FormattingCheck.ps1（No.32）のCI検証バッチと対をなし、本バッチでフォーマットを適用した結果がCIで検証される。runformat.cmd（No.30）がC++コードのフォーマットを担当するのに対し、本バッチはXAMLファイルのフォーマットを専門に担当する。

**影響範囲**：gitリポジトリ内の全XAMLファイル（`**/*.xaml`）が対象。フォーマット適用後、ファイルの内容が変更される可能性がある。

## バッチ種別

コード整形

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| 環境変数 `%OPENCON_TOOLS%` | razzle.cmdにより設定されるツールディレクトリへのパス。OpenConsole.psm1の配置先 |
| dotnet CLI | dotnet tool restoreおよびdotnet tool runの実行に必要 |
| git | git ls-filesによるXAMLファイル一覧取得に必要 |
| PowerShell | powershell -noprofileで実行されるため、PowerShellが利用可能であること |
| NuGetパッケージソース | dotnet tool restoreがnuget.orgからXamlStylerパッケージを復元するために必要 |

### 実行可否判定

特段の判定ロジックはない。環境変数 `%OPENCON_TOOLS%` が設定されていない場合、OpenConsole.psm1のインポートに失敗しエラーとなる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本バッチはコマンドライン引数を受け取らない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| `**/*.xaml` | XAML | gitリポジトリ内の全XAMLファイル（git ls-filesで列挙） |
| `XamlStyler.json` | JSON | XamlStylerの設定ファイル（リポジトリルート配置） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| `**/*.xaml` | XAML | フォーマット適用後のXAMLファイル（上書き） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 入力と同一（上書き） |
| 出力先 | 入力と同一パス |
| 文字コード | UTF-8（BOMなし） |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. バッチ開始（@echo off）
   └─ コマンドエコーを無効化
2. PowerShellモジュールインポート
   └─ %OPENCON_TOOLS%\openconsole.psm1をインポート
3. Invoke-XamlFormat関数実行
   └─ 3-1. dotnet tool restore実行（XamlStylerパッケージの復元）
   └─ 3-2. git ls-filesで全XAMLファイルを列挙
   └─ 3-3. xstylerをXamlStyler.json設定で実行
   └─ 3-4. 各XAMLファイルからBOMを除去
4. バッチ終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[OpenConsole.psm1インポート]
    B --> C[dotnet tool restore]
    C --> D[git ls-filesで全XAMLファイル列挙]
    D --> E[xstylerでフォーマット適用]
    E --> F[各XAMLファイルのBOM除去]
    F --> G[バッチ終了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 環境変数未設定 | `%OPENCON_TOOLS%` が未設定 | razzle.cmdを先に実行して環境変数を設定する |
| - | モジュールインポート失敗 | OpenConsole.psm1が見つからない | toolsディレクトリの存在を確認する |
| - | dotnet tool restore失敗 | NuGetソースへの接続不可 | ネットワーク接続を確認する |
| - | git ls-files失敗 | gitリポジトリ外で実行 | リポジトリルートから実行する |

### リトライ仕様

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

### 障害時対応

エラー発生時はPowerShellのエラー出力を確認し、環境変数やツールの存在を確認する。dotnet tool restoreが失敗する場合はネットワーク接続を確認する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（ファイル操作のみ） |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし（gitの差分確認で手動復旧可能） |

## パフォーマンス要件

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

## 排他制御

同時実行の制御は行わない。同一リポジトリ上で複数回同時実行した場合、ファイルの競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | dotnet tool restore時 | パッケージ復元の進捗 |
| エラー出力 | 異常時 | PowerShellのエラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 該当なし | - | - |

## 備考

- 本バッチは `powershell -noprofile` オプションでPowerShellを起動するため、ユーザープロファイルの読み込みは行わない
- xstylerは全XAMLファイルを「touch」するため、変更がなくてもファイルのタイムスタンプが更新される可能性がある
- BOM除去処理は `[IO.File]::WriteAllLines()` を使用して行われる
- ソースファイル: `tools/runxamlformat.cmd`
