# バッチ設計書 2-check-blueprints.sh

## 概要

本ドキュメントは、GTK Blueprintファイル（.blp）のフォーマットとコンパイルチェックを実行するビルドサポートスクリプト `check-blueprints.sh` の設計仕様を記載する。

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

本バッチは、GhosttyのGTKアプリケーションで使用されるBlueprintファイルの品質を検証するスクリプトである。

**業務上の目的・背景**：GhosttyはLinux環境でGTK4をUIフレームワークとして使用しており、UIの定義にBlueprintという宣言的UI記述言語を採用している。Blueprintファイルは最終的にGTK UIファイル形式にコンパイルされるため、シンタックスエラーや不正なウィジェット定義が含まれていると、アプリケーションのビルドや実行時にクラッシュが発生する。本スクリプトは、CI段階でBlueprintファイルの整形とコンパイル検証を行い、問題を早期に発見することを目的とする。

**バッチの実行タイミング**：CI/CD パイプライン実行時（Blueprintファイルに変更があった場合）、および開発者による手動実行時

**主要な処理内容**：
1. srcディレクトリ配下の全.blpファイルを検索
2. blueprint-compiler formatコマンドで各ファイルをフォーマット
3. blueprint-compiler compileコマンドで各ファイルをコンパイル（出力は/dev/nullに破棄）

**前後の処理との関連**：GTK Blueprintファイルの編集後に実行し、フォーマット・コンパイルエラーがないことを確認する。CIではtest.ymlワークフロー内のblueprint-compilerジョブから呼び出される。

**影響範囲**：GTK UIの定義ファイルに直接影響を与える（フォーマット実行時）

## バッチ種別

コード品質チェック / フォーマッタ

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（CIトリガー/手動） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | push/PR（.blpファイル変更時） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| blueprint-compiler | blueprint-compilerコマンドが利用可能であること |
| srcディレクトリ | srcディレクトリが存在すること |

### 実行可否判定

- srcディレクトリ内に.blpファイルが1つ以上存在すること（存在しない場合も正常終了）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 入力パラメータなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| src/**/*.blp | Blueprint | GTK Blueprint UIファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| src/**/*.blp | Blueprint | フォーマット済みファイル（上書き） |
| /dev/null | - | コンパイル出力（破棄） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 既存の.blpファイル |
| 出力先 | 元のファイル位置 |
| 文字コード | UTF-8 |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. シェルオプション設定
   └─ set -o nounset -o pipefail -o errexit で厳格モード有効化
2. Blueprintファイルのフォーマット
   └─ find src -name \*.blp で全.blpファイルを検索
   └─ blueprint-compiler format で各ファイルをフォーマット
3. Blueprintファイルのコンパイルチェック
   └─ find src -name \*.blp で全.blpファイルを検索
   └─ blueprint-compiler compile --output=/dev/null で各ファイルをコンパイル検証
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[シェルオプション設定]
    B --> C[.blpファイル検索]
    C --> D[blueprint-compiler format実行]
    D --> E[.blpファイル検索]
    E --> F[blueprint-compiler compile実行]
    F --> G{コンパイルエラー?}
    G -->|なし| H[正常終了]
    G -->|あり| I[エラー終了]
```

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

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

本バッチはデータベースを使用しない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非0 | フォーマットエラー | Blueprintファイルに文法エラー | ファイルの文法を修正 |
| 非0 | コンパイルエラー | 不正なウィジェット定義等 | エラーメッセージに従い修正 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認し、問題のあるBlueprintファイルを特定
2. ファイルの文法エラーまたはウィジェット定義エラーを修正
3. 再度スクリプトを実行して検証

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（ファイル操作） |
| コミットタイミング | ファイルごとに即時書き込み |
| ロールバック条件 | なし（gitで差分を確認可能） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数十ファイル |
| 目標処理時間 | 10秒以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

特になし。ただし、同一ファイルへの同時書き込みは避けること。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | なし | - |
| 進捗ログ | なし | - |
| 終了ログ | なし | - |
| エラーログ | コンパイルエラー時 | blueprint-compilerのエラー出力 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | != 0 | CI失敗通知 |

## 備考

- `set -o nounset`: 未定義変数の使用でエラー
- `set -o pipefail`: パイプラインのいずれかのコマンドが失敗した場合にエラー
- `set -o errexit`: コマンド失敗時に即座に終了
- formatコマンドは `+` を使用して複数ファイルをまとめて処理（効率化）
- compileコマンドは `;` を使用して1ファイルずつ処理（出力を個別に破棄するため）
