# バッチ設計書 4-ucs-detect.sh

## 概要

本ドキュメントは、Unicode文字検出テストを一定の設定で実行するテストスクリプト `ucs-detect.sh` の設計仕様を記載する。

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

本バッチは、GhosttyターミナルエミュレータのUnicode文字幅検出機能をテストするスクリプトである。

**業務上の目的・背景**：ターミナルエミュレータにおいて、Unicode文字の表示幅（1文字幅か2文字幅か等）の判定は、カーソル位置の計算やテキストの整列に直接影響する重要な機能である。ucs-detectツールは、ターミナルエミュレータが各Unicode文字をどの幅で認識しているかを自動的に検出・テストする外部ツールであり、Ghosttyの文字幅実装の正確性を検証するために使用される。本スクリプトは、テスト設定を固定することで、異なる時点での結果比較を可能にしている。

**バッチの実行タイミング**：開発者による手動実行時（Unicode処理の変更後など）

**主要な処理内容**：
1. ucs-detectツールの実行
2. コードポイント数制限（5000）、単語数制限（5000）、エラー数制限（1000）の設定
3. 標準エラー出力へのストリーム出力

**前後の処理との関連**：Unicode文字幅処理のコード変更後に実行し、以前の結果と比較してリグレッションを検出する。

**影響範囲**：テスト結果の出力のみ、システムへの永続的な影響はない

## バッチ種別

テスト実行 / 品質検証

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| ucs-detect | ucs-detectツールがインストールされていること |
| Ghosttyターミナル | Ghosttyターミナル上で実行すること |

### 実行可否判定

- ucs-detectコマンドが利用可能であること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 固定パラメータでの実行 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| ターミナル | インタラクティブ | ucs-detectがターミナルに問い合わせを行う |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準エラー | テキスト | ucs-detectのテスト結果出力 |

### 出力ファイル仕様

本バッチはファイル出力を行わない。

## 処理フロー

### 処理シーケンス

```
1. ucs-detect実行
   └─ --limit-codepoints=5000: テスト対象コードポイント数を5000に制限
   └─ --limit-words=5000: テスト対象単語数を5000に制限
   └─ --limit-errors=1000: 報告するエラー数を1000に制限
   └─ --stream=stderr: 結果を標準エラーに出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[ucs-detect実行]
    B --> C[Unicode文字幅テスト]
    C --> D[結果を標準エラーに出力]
    D --> E[バッチ終了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非0 | コマンド不在 | ucs-detectがインストールされていない | pipでucs-detectをインストール |
| 非0 | ターミナル非対応 | 非対応ターミナルで実行 | Ghosttyターミナルで実行 |

### リトライ仕様

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

### 障害時対応

1. ucs-detectがインストールされていることを確認: `pip install ucs-detect`
2. Ghosttyターミナル上で実行していることを確認

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 5000コードポイント |
| 目標処理時間 | 数分（ターミナル応答速度依存） |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

ターミナルセッション単位での実行となるため、排他制御は不要。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | なし | - |
| 進捗ログ | テスト中 | ucs-detectの進捗出力（stderr） |
| 終了ログ | なし | - |
| エラーログ | なし | - |

## 監視・アラート

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

## 備考

- 本スクリプトの設定値は jquast/ucs-detect リポジトリの ghostty.yaml 設定ファイルに基づいている
- --stream=stderr オプションにより、結果がリアルタイムで標準エラーに出力される
- テスト結果を保存する場合は、標準エラーをファイルにリダイレクトする: `./test/ucs-detect.sh 2> results.txt`
- ucs-detectは Python で実装されたツールであり、pip でインストール可能
