# バッチ設計書 42-CompressJson.ps1

## 概要

本ドキュメントは、JSONファイルのホワイトスペースを除去して圧縮出力するPowerShellスクリプト「CompressJson.ps1」のバッチ設計書である。

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

指定されたJSONファイルを読み込み、ホワイトスペース（インデント、改行等）を除去した圧縮形式で出力ファイルに書き出す。ビルド成果物のサイズ削減やリソース埋め込み用のJSON圧縮を自動化するコード生成バッチである。

**業務上の目的・背景**：Windows Terminalプロジェクトでは、設定スキーマやデフォルト設定などのJSONファイルがアプリケーションに同梱される。開発時は可読性のためにインデント付きのJSONを使用するが、配布時にはファイルサイズを削減するためにホワイトスペースを除去した圧縮形式が望ましい。本バッチはこの圧縮作業を自動化し、ビルドプロセスの一部としてJSON圧縮を行う。

**バッチの実行タイミング**：ビルドプロセスの一部として、JSONファイルを成果物に含める前に実行される。JSONファイルが変更された場合に随時実行される。

**主要な処理内容**：
1. 入力JSONファイルを生データ（Raw）として読み込む
2. ConvertFrom-JsonでPowerShellオブジェクトに変換する
3. ConvertTo-Json -Compressで圧縮JSON文字列に変換する（Depth 100で深いネスト対応）
4. 圧縮されたJSON文字列をUTF-8エンコーディングで出力ファイルに書き出す

**前後の処理との関連**：GenerateHeaderForJson.ps1（No.40）などのJSON埋め込み処理の前段で使用される可能性がある。ビルドプロセスにおいてJSONリソースの前処理として機能する。

**影響範囲**：出力されたJSONファイルはアプリケーションのリソースまたは設定ファイルとして使用される。圧縮により可読性は失われるが、内容の等価性は保持される。

## バッチ種別

コード生成（データ変換）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（ビルド時） |
| 実行時刻 | ビルドプロセス依存 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | ビルドプロセス／手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| 入力JSONファイルの存在 | JsonFileパラメータで指定されたパスに有効なJSONファイルが存在すること |
| PowerShell実行環境 | PowerShellが利用可能であること |
| 出力先ディレクトリの存在 | OutPathで指定される出力先のディレクトリが存在すること |

### 実行可否判定

2つの必須パラメータ（JsonFile、OutPath）がすべて指定されていること。パラメータが不足している場合はPowerShellの必須パラメータ検証によりエラーとなる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| JsonFile | string | Yes | なし | 圧縮対象のJSONファイルのパス |
| OutPath | string | Yes | なし | 圧縮後のJSONファイルの出力先パス |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| JSONファイル | JSON | 任意のJSON形式ファイル（ネスト深度100まで対応） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| OutPathで指定されたファイル | JSON | ホワイトスペース除去された圧縮JSONファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | OutPathパラメータで指定 |
| 出力先 | OutPathパラメータで指定 |
| 文字コード | UTF-8 |
| 区切り文字 | 該当なし（JSON形式） |

## 処理フロー

### 処理シーケンス

```
1. JSONファイル読み込み
   └─ Get-Content -Raw $JsonFile で生データとして読み込み
2. JSONパース
   └─ ConvertFrom-Json でPowerShellオブジェクトに変換
3. JSON圧縮
   └─ ConvertTo-Json -Compress -Depth 100 で圧縮JSON文字列に変換
4. ファイル出力
   └─ Out-File -FilePath $OutPath -Encoding utf8 でUTF-8エンコーディングで保存
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[JSONファイル読み込み]
    B --> C[ConvertFrom-Json パース]
    C --> D[ConvertTo-Json -Compress 圧縮]
    D --> E[UTF-8でファイル出力]
    E --> F[バッチ終了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | パラメータ不足 | 必須パラメータが未指定 | 2つの必須パラメータをすべて指定する |
| N/A | ファイル読み込みエラー | 入力ファイルが存在しないまたは読み取り不可 | ファイルパスと権限を確認する |
| N/A | JSON解析エラー | 入力ファイルが不正なJSON形式 | 入力JSONの構文を確認する |
| N/A | ファイル書き込みエラー | 出力先パスへの書き込み権限がない | 出力先ディレクトリの権限を確認する |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（リトライ機構なし） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

ビルドプロセスの一部として実行されるため、エラー発生時はビルドが失敗する。入力JSONファイルの整合性を確認し、再度ビルドを実行する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（ファイル操作のみ） |
| コミットタイミング | Out-Fileによる一括書き込み |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1ファイル |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | 特に制限なし（通常のJSON処理） |

## 排他制御

同一出力ファイルへの同時書き込みは想定されていない。ビルドプロセスにより順序が制御される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | なし | スクリプトは標準出力への明示的なログ出力を行わない |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ビルドエラー | 発生時 | ビルドシステム（CI/CD） |

## 備考

- `-Depth 100`パラメータにより、深くネストされたJSONオブジェクトも正確に処理される。PowerShellのConvertTo-Jsonはデフォルトではネスト深度が浅いため、この指定は重要である。
- パイプラインで`Get-Content -Raw | ConvertFrom-Json | ConvertTo-Json -Compress`と1行で処理を連結しており、中間変数を使用しない簡潔な実装となっている。
- ソースファイルパス: `tools/CompressJson.ps1`
