# バッチ設計書 10-format-test-lint.js

## 概要

本ドキュメントは、フォーマットテストディレクトリの構造を検証するスクリプト `scripts/format-test-lint.js` の設計仕様を記載したものです。

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

本バッチは、tests/format/ディレクトリ配下の各サブディレクトリに、テスト実行に必要なformat.test.jsファイルが存在するかを検証します。

**業務上の目的・背景**：Prettierのフォーマットテストは、各ディレクトリに配置されたformat.test.jsスクリプトによって実行されます。テストファイルが含まれるディレクトリにformat.test.jsが存在しないと、そのディレクトリのテストが実行されません。本バッチは、テストディレクトリ構造の整合性を検証し、テストの漏れを防止します。

**バッチの実行タイミング**：CI/CDパイプラインでの検証時、テストディレクトリの追加・変更後に実行されます。

**主要な処理内容**：
1. tests/format/ディレクトリを再帰的に走査
2. 各ディレクトリでformat.test.jsの存在を確認
3. テストファイル（format.test.js以外のファイル）が存在するディレクトリにformat.test.jsがない場合はエラー
4. .not-test-directoryファイルでマーク済みのディレクトリはスキップ
5. 問題のあるディレクトリ一覧を出力

**前後の処理との関連**：本バッチはCI/CDの一部として実行され、テストスイートの完全性を保証します。

**影響範囲**：tests/format/ディレクトリ配下の全サブディレクトリ。process.exitCodeの設定によりCIの成功/失敗を制御。

## バッチ種別

検証・リント / テスト構造検証

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（PR時、テスト追加時） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | CI/CD / 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | Node.jsがインストールされていること |
| テストディレクトリ | tests/format/ディレクトリが存在すること |

### 実行可否判定

tests/format/ディレクトリが存在しない場合はエラーとなります。

## 入力仕様

### 入力パラメータ

本バッチはコマンドライン引数を受け取りません。

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| tests/format/ | ディレクトリ | 検証対象のルートディレクトリ |
| tests/format/**/format.test.js | JavaScript | テストスクリプトファイル |
| tests/format/**/.not-test-directory | ファイル | 検証除外マーカー |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| stdout | テキスト | 問題のあるディレクトリ一覧 |
| stderr | テキスト | エラーメッセージ |
| process.exitCode | 数値 | 0:成功、1:エラーあり |

### 出力ファイル仕様

本バッチはファイル出力を行いません。

## 処理フロー

### 処理シーケンス

```
1. 定数の定義
   └─ FORMAT_TEST_DIRECTORY, TEST_SCRIPT_FILE_NAME, IGNORED等を定義
2. ディレクトリの再帰走査
   └─ checkDirectory関数でジェネレータを使用して走査
3. 各ディレクトリの検証
   └─ ルートディレクトリはスキップ
   └─ .not-test-directoryファイルがあればスキップ
   └─ ファイルがなければスキップ
   └─ format.test.jsがあればOK
   └─ 上記以外はエラー
4. 結果の集計と出力
   └─ for awaitで結果を収集
   └─ ok=falseのディレクトリを一覧表示
5. 最終結果の出力
   └─ 問題なければ"Pass."
   └─ 問題があれば件数とエラーメッセージ
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[定数定義]
    B --> C[checkDirectory開始]
    C --> D{IGNOREDに含まれる?}
    D -->|Yes| E[スキップ]
    D -->|No| F[ディレクトリ内容読み込み]
    F --> G{ルートディレクトリ?}
    G -->|Yes| H[ok=true]
    G -->|No| I{.not-test-directory存在?}
    I -->|Yes| H
    I -->|No| J{ファイルが存在?}
    J -->|No| H
    J -->|Yes| K{format.test.js存在?}
    K -->|Yes| H
    K -->|No| L[ok=false]
    H --> M[yield結果]
    L --> M
    M --> N[サブディレクトリ再帰]
    N --> O[結果収集]
    O --> P{問題あり?}
    P -->|Yes| Q[エラー出力]
    P -->|No| R[Pass出力]
    Q --> S[process.exitCode=1]
    S --> T[バッチ終了]
    R --> T
```

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

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

本バッチはデータベースを使用しません。

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

N/A

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Missing format.test.js | テストファイルがあるディレクトリにformat.test.jsがない | format.test.jsを追加、または.not-test-directoryを作成 |

### リトライ仕様

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

### 障害時対応

format.test.jsが欠落しているディレクトリが検出された場合：
1. テストスクリプトを作成するか
2. .not-test-directoryマーカーファイルを作成してテストディレクトリではないことを示す

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（読み取り専用） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数百のテストディレクトリ |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | Node.jsデフォルト制限に依存 |

## 排他制御

読み取り専用の処理のため、排他制御は不要です。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| エラーログ | 問題検出時 | ` - {ディレクトリパス}` |
| エラーメッセージ | 検証完了時 | `{件数} above missing "format.test.js" file.` |
| 成功ログ | 検証成功時 | `Pass.` |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| process.exitCode | 1 | CI/CD失敗 |

## 備考

- ジェネレータ関数（async function*）で効率的な再帰走査を実装
- fs.readdir()のwithFileTypesオプションでDirentオブジェクトを取得
- __snapshots__ディレクトリはスナップショット格納用のため検査対象外
- IGNOREDセットで特定ディレクトリを検査対象外に設定可能
- dirent.parentPathでサブディレクトリの絶対パスを構築
- path.relativeとreplaceAllでWindows/Unix両対応のパス表示
- for await...of でジェネレータの結果を非同期で収集
- 複数形/単数形の使い分け（directories/directory）
