# バッチ設計書 1-format

## 概要

本ドキュメントは、InvenTreeモバイルアプリのDartソースコードに対してコードフォーマット処理を実行するPythonビルドタスク「format」の設計仕様を記載します。

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

本バッチは、dart formatコマンドを使用してlib配下のDartファイルを統一されたコードスタイルにフォーマットする処理を実行します。

**業務上の目的・背景**：開発チームが複数人で作業する際、コードの書式が統一されていないと可読性が低下し、コードレビューの効率も悪化します。本バッチを実行することで、プロジェクト全体のコードスタイルを自動的に統一し、コード品質の維持とチーム開発の効率化を実現します。

**バッチの実行タイミング**：開発者が手動でinvoke formatコマンドを実行した際に随時実行されます。また、CI/CDパイプラインの静的解析テスト時にもフォーマットチェックが行われます。

**主要な処理内容**：
1. fvm（Flutter Version Manager）を使用してdart formatコマンドを実行
2. libディレクトリ配下の全Dartファイルに対してフォーマットを適用
3. 一貫したコードスタイル（インデント、空白、改行等）を適用

**前後の処理との関連**：本バッチは独立して実行可能ですが、他のビルドタスク（ios/android）の前提タスクには含まれていません。CIパイプラインでは静的解析の一部としてフォーマットチェックが実行されます。

**影響範囲**：lib配下の全Dartソースファイル（.dart）が対象となります。

## バッチ種別

コード整形処理（ビルドサポートタスク）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | なし（手動実行） |
| 実行曜日 | なし |
| 実行日 | なし |
| トリガー | 手動（invoke formatコマンド） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| FVMインストール済み | Flutter Version Managerがインストールされていること |
| Dart SDKインストール済み | FVMで管理されたDart SDKが利用可能であること |
| プロジェクトルートディレクトリ | プロジェクトのルートディレクトリで実行すること |

### 実行可否判定

libディレクトリが存在し、Dartファイルが含まれている場合に実行可能です。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| lib/*.dart | Dartソースファイル | フォーマット対象のDartファイル群 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| lib/*.dart | Dartソースファイル | フォーマット済みのDartファイル群（上書き） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 入力ファイルと同一（上書き） |
| 出力先 | lib配下（元のパスを維持） |
| 文字コード | UTF-8 |
| 区切り文字 | なし |

## 処理フロー

### 処理シーケンス

```
1. invokeコマンド実行
   └─ tasks.pyのformat関数が呼び出される
2. dart formatコマンド実行
   └─ fvm dart format libが実行される
3. フォーマット処理
   └─ lib配下の全Dartファイルがフォーマットされる
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[fvm dart format lib 実行]
    B --> C{Dartファイル存在チェック}
    C -->|あり| D[フォーマット処理実行]
    C -->|なし| E[処理スキップ]
    D --> F[ファイル上書き保存]
    F --> G[バッチ終了]
    E --> G
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| なし | - | - | データベース操作なし |

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

データベース操作は行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | FVM未インストール | fvmコマンドが見つからない | FVMをインストールする |
| - | Dart SDK未設定 | FVMでDart SDKが設定されていない | fvm installを実行する |
| - | 構文エラー | Dartファイルに構文エラーがある | 構文エラーを修正する |

### リトライ仕様

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

### 障害時対応

構文エラーがある場合、該当ファイルのエラー内容がコンソールに出力されます。エラーを修正後、再度実行してください。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（ファイル単位処理） |
| コミットタイミング | 各ファイル処理完了時 |
| ロールバック条件 | なし |

## パフォーマンス要件

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

## 排他制御

同時実行に対する排他制御はありません。ただし、同時に複数のformat処理を実行した場合、ファイルの書き込み競合が発生する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | フォーマット実行時 | フォーマット対象ファイル一覧 |
| エラー出力 | エラー発生時 | 構文エラー等のエラー詳細 |

## 監視・アラート

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

## 備考

- 本バッチはDart標準のフォーマッタを使用するため、Dartの公式コードスタイルに準拠します
- CIパイプラインでは`dart format --output=none --set-exit-if-changed .`としてフォーマットチェック（変更があればエラー）として使用されます
