# バッチ設計書 16-clean-markdown-legacy-spec

## 概要

本ドキュメントは、Prettierプロジェクトにおける `clean-markdown-legacy-spec.js` バッチの設計仕様を定義します。このバッチは、CommonMarkテストスイートと重複するレガシーMarkdownテストファイルを削除するスクリプトです。

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

このバッチは、CommonMarkの公式テストスイートに含まれるテストケースと重複するレガシーテストファイルを特定し、削除します。重複を排除することで、テストの冗長性を解消し、メンテナンス性を向上させます。

**業務上の目的・背景**：PrettierのMarkdownフォーマッターは、CommonMark仕様に準拠しています。過去にはレガシーなテストファイルが手動で管理されていましたが、`commonmark-test-suite`パッケージの導入により、公式テストケースが利用可能になりました。重複するテストファイルを削除することで、テストの実行時間短縮とメンテナンスコストの削減を実現します。

**バッチの実行タイミング**：CommonMarkテストスイートの更新時、またはテストファイルの整理時に手動で実行します。

**主要な処理内容**：
1. commonmark-test-suiteから全テストケースのMarkdownコンテンツを抽出
2. 既存のテストケースをSetに格納
3. レガシーテストディレクトリ内のファイルをスキャン
4. CommonMarkテストスイートと内容が一致するファイルを削除

**前後の処理との関連**：このバッチは単独で実行されます。テストファイルの削除後は、テストの実行とスナップショットの更新が必要になる場合があります。

**影響範囲**：`tests/format/markdown/spec-legacy/`ディレクトリ内のファイルが削除される可能性があります。

## バッチ種別

クリーンアップ / データクレンジング

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（テスト整理時） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | Node.js実行環境が利用可能であること |
| commonmark-test-suite | パッケージがインストール済みであること |
| レガシーテストディレクトリ | tests/format/markdown/spec-legacy/が存在すること |

### 実行可否判定

commonmark-test-suiteがインストールされ、レガシーテストディレクトリが存在する場合に実行可能です。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | コマンドライン引数は受け取りません |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| commonmark-test-suite | npm package | CommonMark公式テストケース |
| tests/format/markdown/spec-legacy/ | ディレクトリ | レガシーMarkdownテストファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| なし | - | 重複ファイルを削除するのみ |

### 出力ファイル仕様

ファイル出力はありません（削除処理のみ）。

## 処理フロー

### 処理シーケンス

```
1. CommonMarkテストケースの読み込み
   └─ commonmark-test-suiteから全リリースのテストケースを取得
   └─ 各テストケースのmarkdownコンテンツを抽出
   └─ trim()して正規化

2. 既存テストケースのSet作成
   └─ 全テストケースのmarkdownをSetに格納

3. レガシーディレクトリのスキャン
   └─ tests/format/markdown/spec-legacy/内のファイルを列挙
   └─ ディレクトリはスキップ

4. 重複判定と削除
   └─ 各ファイルの内容を読み込む
   └─ trim()した内容がSetに存在するか確認
   └─ 存在する場合はファイルを削除
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[commonmark-test-suite読み込み]
    B --> C[全テストケースのmarkdownをSetに格納]
    C --> D[レガシーディレクトリをスキャン]
    D --> E[各ファイルをループ]
    E --> F{ディレクトリ?}
    F -->|はい| G[スキップ]
    F -->|いいえ| H[ファイル内容読み込み]
    H --> I{CommonMarkに存在?}
    I -->|はい| J[ファイル削除]
    I -->|いいえ| K[保持]
    G --> L{次のファイル?}
    J --> L
    K --> L
    L -->|あり| E
    L -->|なし| M[バッチ終了]
```

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

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

データベース操作はありません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | パッケージ読み込みエラー | commonmark-test-suiteがインストールされていない | yarn installを実行 |
| - | ディレクトリ読み込みエラー | レガシーディレクトリが存在しない | ディレクトリを作成するか、スクリプトをスキップ |

### リトライ仕様

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

### 障害時対応

1. パッケージがない場合は`yarn install`を実行
2. ディレクトリがない場合は処理をスキップ

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | ファイル単位 |
| コミットタイミング | 各ファイル削除時 |
| ロールバック条件 | なし（削除は取り消し不可） |

## パフォーマンス要件

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

## 排他制御

同時実行の制限はありません。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| なし | - | ログ出力は実装されていません |

## 監視・アラート

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

## 備考

- ES Modules形式で実装されています
- commonmark-test-suiteの全リリースバージョンのテストケースを対象としています
- ファイル内容の比較はtrim()した文字列で行われます
- ディレクトリエントリはwithFileTypes: trueオプションで取得されます
- 削除されたファイルは復元できないため、実行前にgit statusで状態を確認することを推奨します
