# バッチ設計書 15-format.ts

## 概要

本ドキュメントは、Prettierを使用してコードフォーマットを実行するスクリプトの設計書です。プロジェクト全体のコードスタイルを統一します。

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

このスクリプトは、Bunランタイムで実行され、Prettierを使用してプロジェクト内の全ファイルを自動フォーマットします。シンプルなラッパースクリプトとして機能し、一貫したコードスタイルを維持します。

**業務上の目的・背景**：チーム開発において、コードスタイルの不統一はコードレビューの効率低下やマージコンフリクトの原因となります。このスクリプトにより、コミット前やCI/CDパイプラインでコードフォーマットを自動化し、一貫したコードスタイルを担保します。

**バッチの実行タイミング**：開発者による手動実行、または他のスクリプト（generate.tsなど）からの呼び出し時に実行されます。

**主要な処理内容**：
1. Bunシェルコマンドでprettierを実行
2. --ignore-unknownオプションで未対応ファイル形式をスキップ
3. --writeオプションでファイルを直接更新

**前後の処理との関連**：generate.tsスクリプトの最後に呼び出されます。コミットフック（pre-commit）やCIパイプラインから呼び出されることもあります。

**影響範囲**：プロジェクト内の全ソースファイル（対応する拡張子のみ）

## バッチ種別

開発ツール / コードフォーマッター / ユーティリティスクリプト

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 手動（随時） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 手動実行 / スクリプト呼び出し |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Bunランタイム | Bunがインストールされていること |
| Prettier | node_modulesにprettierがインストールされていること |
| .prettierrc | Prettier設定ファイルが存在すること（オプション） |

### 実行可否判定

前提条件が満たされていれば常に実行可能です。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| ソースファイル | 各種 | プロジェクト内の全ファイル |
| .prettierrc | JSON/YAML | Prettier設定 |
| .prettierignore | Text | 除外パターン |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| ソースファイル | 各種 | フォーマット済みファイル（上書き） |

### 出力ファイル仕様

入力ファイルを直接上書きします。ファイル形式・エンコーディングは維持されます。

## 処理フロー

### 処理シーケンス

```
1. スクリプト起動
   └─ Bunシェルによるコマンド実行
2. Prettier実行
   └─ bun run prettier --ignore-unknown --write .
3. ファイル更新
   └─ 対象ファイルを直接上書き
```

### フローチャート

```mermaid
flowchart TD
    A[スクリプト開始] --> B[Prettierコマンド実行]
    B --> C[ファイル走査]
    C --> D{対応形式?}
    D -->|Yes| E[フォーマット適用]
    D -->|No| F[スキップ]
    E --> G[ファイル上書き]
    F --> H{次のファイル}
    G --> H
    H -->|あり| C
    H -->|なし| I[終了]
```

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

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

本スクリプトはデータベースを操作しません。

### テーブル別操作詳細

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 依存関係エラー | prettierが見つからない | bun installを実行 |
| - | パースエラー | 構文エラーのあるファイル | ファイルを手動修正 |
| - | 書き込みエラー | ファイル権限不足 | 権限を確認 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認
2. 問題のあるファイルを特定
3. 手動で修正後、再実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | ファイル単位 |
| コミットタイミング | 各ファイル処理完了時 |
| ロールバック条件 | Gitによる復元が必要 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数百〜数千ファイル |
| 目標処理時間 | 30秒以内 |
| メモリ使用量上限 | 標準的なNode.jsプロセス |

## 排他制御

同時実行は推奨されません。同一ファイルへの同時書き込みが発生する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | 処理完了時 | フォーマット済みファイル一覧 |
| エラー出力 | エラー発生時 | パースエラー詳細 |

## 監視・アラート

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

ローカル実行スクリプトのため、監視・アラートは設定されていません。

## 備考

- shebang行（`#!/usr/bin/env bun`）により、`./script/format.ts`として直接実行可能
- Bunのシェル機能（`$`テンプレートリテラル）を使用
- generate.tsスクリプトの最終ステップとして呼び出される
- .prettierignoreファイルで除外パターンを設定可能
