# 通知設計書 10-無効なテストフォルダレイアウト警告

## 概要

本ドキュメントは、Babelのテストフィクスチャ読み込み処理において、テストフォルダの構造が不正な場合にスキップ警告を出力する機能について設計内容を記載する。

### 本通知の処理概要

この通知は、`@babel/helper-fixtures`パッケージがテストフィクスチャを読み込む際に、テストフォルダの構造が期待されるレイアウトに沿っていない場合に警告を表示する機能である。

**業務上の目的・背景**：Babelのテストフィクスチャシステムは、特定のディレクトリ構造を期待している。各テストケースは、`input.js`（または`exec.js`）と`output.js`を含むフォルダとして定義される。この構造に従っていないフォルダが見つかった場合、テストとして処理せずにスキップする。開発者がテストフォルダを誤って作成した場合や、不完全なテストケースがある場合に、この警告により問題を認識できる。

**通知の送信タイミング**：テストフィクスチャの読み込み処理中、各テストフォルダの構造を検証する時点で送信される。

**通知の受信者**：テストを実行している開発者（標準エラー出力を監視しているユーザー）

**通知内容の概要**：「Skipped test folder with invalid layout: {フォルダパス}」というメッセージが出力される。

**期待されるアクション**：開発者は、この警告を確認し、テストフォルダの構造を修正するか、不要なフォルダを削除する。

## 通知種別

コンソール出力（標準エラー出力：stderr）- console.warn使用

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（console.warn） |
| 優先度 | 低（警告） |
| リトライ | なし |

### 送信先決定ロジック

標準エラー出力（stderr）に固定。console.warnを使用。

## 通知テンプレート

### コンソール通知の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | 標準エラー出力（stderr） |
| フォーマット | プレーンテキスト |

### 本文テンプレート

```
Skipped test folder with invalid layout: {taskDir}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| taskDir | 無効なテストフォルダのパス | pushTask関数の引数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ファイル読み込み | テストフォルダ構造検証 | ディレクトリだが`input.*`も`exec.*`も存在しない | 必須ファイルが存在しない場合 |
| ファイル読み込み | テストファイル検証 | ファイルがサポートされない拡張子を持つ | .js/.mjs/.ts/.tsx/.cts/.mts/.vue以外 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 正常なテストフォルダ | `input.*`または`exec.*`が存在する場合 |
| 無視対象ファイル | .で始まるファイル、.md、LICENSE、options、package.jsonなど |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[pushTask呼び出し] --> B[fs.statSync: ファイル/ディレクトリ判定]
    B --> C{ディレクトリ?}
    C -->|Yes| D[ディレクトリ内ファイル走査]
    D --> E{input.* または exec.* 存在?}
    E -->|No かつ files.length > 0| F[console.warn出力]
    E -->|Yes| G[テストケース作成]
    C -->|No| H{サポート拡張子?}
    H -->|Yes| I[テストケース作成]
    H -->|No| J[console.warn出力]
    F --> K[早期リターン]
    J --> K
    G --> L[処理継続]
    I --> L
```

## データベース参照・更新仕様

該当なし（データベースを使用しない）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 無効レイアウト | input/execファイルがないディレクトリ | 警告を出力してスキップ |
| サポート外拡張子 | .js/.mjs/.ts/.tsx/.cts/.mts/.vue以外のファイル | 警告を出力してスキップ |

### リトライ仕様

リトライなし

## 配信設定

### レート制限

該当なし

### 配信時間帯

制限なし

## セキュリティ考慮事項

テストフォルダのパスが出力されるが、開発環境での使用を想定しているため問題はない。

## 備考

- この警告は@babel/helper-fixturesパッケージの一部であり、Babelの内部テスト用
- 警告が出力された場合、そのフォルダはテストスイートから除外される
- 有効な拡張子はEXTENSIONS定数で定義されている

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

この通知に関わるデータ構造は、テストケースの構造である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | index.ts | `packages/babel-helper-fixtures/src/index.ts` | Test型の定義（27-47行目）を確認 |
| 1-2 | index.ts | `packages/babel-helper-fixtures/src/index.ts` | EXTENSIONS定数の定義（101行目）を確認 |

**読解のコツ**: テストケースはTestインターフェースで定義され、actual（入力）、expect（期待出力）、exec（実行テスト）などのプロパティを持つ。

#### Step 2: エントリーポイントを理解する

テストフォルダの読み込み処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | index.ts | `packages/babel-helper-fixtures/src/index.ts` | pushTask関数（122-362行目） |

**主要処理フロー**:
1. **128行目**: `fs.statSync(taskDir)` でファイル/ディレクトリを判定
2. **141-175行目**: ディレクトリの場合、ファイルを走査して`input.*`/`exec.*`を探す
3. **176-179行目**: ファイルはあるが`input.*`も`exec.*`もない場合、警告出力
4. **186-195行目**: ファイルの場合、拡張子チェックと警告出力

#### Step 3: 警告出力箇所の詳細を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | index.ts | `packages/babel-helper-fixtures/src/index.ts` | 警告出力箇所（177行目、193行目） |

**主要処理フロー**:
- **176-179行目**: ディレクトリでinput/execがない場合
  ```typescript
  if (files.length > 0 && !actualLoc && !execLoc) {
    console.warn(`Skipped test folder with invalid layout: ${taskDir}`);
    return;
  }
  ```
- **193-195行目**: ファイルでサポート外拡張子の場合
  ```typescript
  } else {
    console.warn(`Skipped test folder with invalid layout: ${taskDir}`);
    return;
  }
  ```

### プログラム呼び出し階層図

```
テスト実行 (jest/mocha等)
    │
    └─ @babel/helper-fixtures
           │
           └─ get() または multiple()
                  │
                  └─ pushTask(taskName, taskDir, suite, suiteName)
                         │
                         ├─ fs.statSync(taskDir)
                         │      │
                         │      ├─ [isDirectory]
                         │      │      │
                         │      │      ├─ files走査
                         │      │      │
                         │      │      └─ [!actualLoc && !execLoc]
                         │      │             │
                         │      │             └─ console.warn(...)
                         │      │
                         │      └─ [isFile]
                         │             │
                         │             └─ [!EXTENSIONS.includes(ext)]
                         │                    │
                         │                    └─ console.warn(...)
                         │
                         └─ suite.tests.push(test)
```

### データフロー図

```
[入力]                       [処理]                           [出力]

taskDir ───────────────────▶ pushTask()
                                   │
                                   ▼
                           fs.statSync(taskDir)
                                   │
                       ┌───────────┴───────────┐
                       ▼                       ▼
                [isDirectory]              [isFile]
                       │                       │
                       ▼                       ▼
               ファイル走査             拡張子チェック
                       │                       │
                       ▼                       ▼
              [!input && !exec]    [!EXTENSIONS.includes]
                       │                       │
                       └───────────┬───────────┘
                                   │
                                   ▼
                           console.warn() ───────▶ stderr: "Skipped test folder..."
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| index.ts | `packages/babel-helper-fixtures/src/index.ts` | ソース | テストフィクスチャ読み込みと警告出力 |
