# バッチ設計書 18-clean

## 概要

本ドキュメントは、Decap CMSプロジェクトにおけるクリーンアップバッチ `clean` の設計仕様を定義する。本バッチは全パッケージのdistディレクトリ、node_modules、Nxキャッシュを削除してプロジェクトをクリーンな状態に戻す。

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

本バッチは、Decap CMSモノレポのビルド成果物、依存パッケージ、ビルドキャッシュを一括削除し、プロジェクトを初期状態に戻すためのスクリプトである。rimrafパッケージを使用してクロスプラットフォーム対応のディレクトリ削除を行う。

**業務上の目的・背景**：ビルドキャッシュの不整合やnode_modulesの依存関係の問題が発生した場合に、プロジェクトを完全にクリーンな状態に戻すために使用する。ビルドの問題切り分けやCI環境の再現テスト前にも有用である。`npm run reset` は本バッチのエイリアスである。

**バッチの実行タイミング**：開発者による手動実行（随時）。ビルド問題の解決時、依存関係の更新後、クリーンビルドが必要な場合に実行される。

**主要な処理内容**：
1. `packages/*/dist` - 全パッケージのビルド出力ディレクトリを削除
2. `dev-test/dist` - デモサイトのビルド出力ディレクトリを削除
3. `packages/*/node_modules` - 全パッケージ個別のnode_modulesを削除
4. `.nx/cache` - Nxビルドキャッシュを削除

**前後の処理との関連**：本バッチ実行後は `npm ci` または `npm install` で依存関係の再インストール、その後 `npm run build`（No.7）でビルドを再実行する必要がある。`npm run reset` は本バッチのエイリアスである。

**影響範囲**：packages/*/dist/、dev-test/dist/、packages/*/node_modules/、.nx/cache/ が完全に削除される。削除後はビルドやテストの実行にはnpm installとビルドの再実行が必要。

## バッチ種別

ユーティリティ（クリーンアップ - ビルド成果物・キャッシュ削除）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | なし |
| 実行日 | なし |
| トリガー | 手動（開発者によるローカル実行） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js | Node.js がインストールされていること |
| rimraf | rimraf パッケージがインストール済みであること（devDependencies） |

### 実行可否判定

特別な実行可否判定は行わない。削除対象のディレクトリが存在しない場合もエラーにならず、正常終了する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本バッチは入力パラメータを取らない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| packages/*/dist | ディレクトリ | 各パッケージのビルド出力 |
| dev-test/dist | ディレクトリ | デモサイトのビルド出力 |
| packages/*/node_modules | ディレクトリ | 各パッケージの個別依存パッケージ |
| .nx/cache | ディレクトリ | Nxビルドキャッシュ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| ファイルシステム | 削除操作 | 対象ディレクトリの完全削除 |
| 標準出力 | テキスト | rimrafの実行ログ（通常は無出力） |
| プロセス終了コード | 数値 | 0: 成功 |

### 出力ファイル仕様

本バッチはファイルの出力ではなく削除を行う。

## 処理フロー

### 処理シーケンス

```
1. rimraf実行
   ├─ "packages/*/dist" - 全パッケージのdistディレクトリを再帰削除
   ├─ dev-test/dist - デモサイトのdistディレクトリを再帰削除
   ├─ "packages/*/node_modules" - 全パッケージのnode_modulesを再帰削除
   └─ ".nx/cache" - Nxキャッシュディレクトリを再帰削除
2. 削除完了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始: npm run clean] --> B[rimraf実行]
    B --> B1[packages/*/dist 削除]
    B --> B2[dev-test/dist 削除]
    B --> B3[packages/*/node_modules 削除]
    B --> B4[.nx/cache 削除]
    B1 --> C[削除完了]
    B2 --> C
    B3 --> C
    B4 --> C
    C --> D[バッチ正常終了]
```

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

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

本バッチはデータベースへのアクセスを行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | 権限エラー | 削除対象ディレクトリにアクセス権限がない | 管理者権限で再実行 |
| 1 | ファイルロック | ファイルが他のプロセスで使用中 | 使用中のプロセスを停止後に再実行 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（手動再実行） |
| リトライ間隔 | なし |
| リトライ対象エラー | なし |

### 障害時対応

権限エラーやファイルロックの場合は、原因となるプロセスの停止または権限の確認を行ってから再実行する。rimrafは存在しないディレクトリの削除はエラーにしないため、部分的な削除が発生しても再実行で対応可能。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（各ディレクトリ削除は独立） |
| コミットタイミング | なし |
| ロールバック条件 | なし（削除は不可逆、npm ciで再構築） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 4パターンのglob対象ディレクトリ |
| 目標処理時間 | 数秒〜数十秒（ディレクトリサイズに依存） |
| メモリ使用量上限 | Node.jsデフォルトヒープサイズ |

## 排他制御

ビルドやテストの実行中にcleanを実行すると、使用中のファイルが削除されて予期しないエラーが発生する可能性がある。ビルド・テスト・開発サーバーが停止していることを確認してから実行することを推奨する。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | rimrafコマンドの実行（npmスクリプト名） |
| 終了ログ | バッチ終了時 | 正常終了（通常は無出力） |
| エラーログ | エラー発生時 | 権限エラー・ファイルロックの詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | なし（ローカル実行のため） | なし |
| エラー件数 | なし（ローカル実行のため） | なし |

## 備考

- 本バッチは `npm run clean` または `npm run reset`（エイリアス）コマンドで実行される
- rimrafはNode.jsのクロスプラットフォーム対応rm -rfコマンドであり、Windows環境でも動作する
- ルートのnode_modulesは削除対象に含まれない（packages/*/node_modulesのみ）
- clean実行後は `npm ci && npm run build` でプロジェクトを再構築する
- rimrafバージョン: ^3.0.0
- 削除パターン: `"packages/*/dist"`, `dev-test/dist`, `"packages/*/node_modules"`, `".nx/cache"`
