# バッチ設計書 5-Clean

## 概要

本ドキュメントは、Avaloniaプロジェクトにおける Nukeビルドターゲット `Clean` のバッチ設計書です。

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

このNukeビルドターゲットは、ビルドディレクトリ、成果物ディレクトリ、NuGetパッケージディレクトリなどをクリーンアップするためのターゲットです。クリーンビルドを実行する前の準備として使用されます。

**業務上の目的・背景**：ビルドプロセスにおいて、前回のビルド成果物が残っていると予期しない問題が発生することがあります。特にリリースビルドや、ビルド構成の変更後には、クリーンな状態からビルドを開始することが重要です。このターゲットは、すべてのビルド関連ディレクトリを削除・クリーンアップし、一貫したビルド結果を保証します。

**バッチの実行タイミング**：他のビルドターゲット（Compile、CompileNativeなど）の依存関係として自動的に実行されるか、または明示的に `./build.sh Clean` として実行されます。

**主要な処理内容**：
1. プロジェクト内のすべてのbin/objディレクトリの削除
2. node_modulesディレクトリの削除
3. artifacts（成果物）ディレクトリのクリーンアップ
4. NuGet中間パッケージディレクトリのクリーンアップ
5. NuGet最終パッケージディレクトリのクリーンアップ
6. ZIPアーカイブディレクトリのクリーンアップ
7. テスト結果ディレクトリのクリーンアップ

**前後の処理との関連**：このターゲットは、Compile、CompileNativeターゲットの依存関係として設定されています。これらのターゲットが実行される前に自動的にCleanが実行されます。

**影響範囲**：プロジェクト全体のビルド成果物、一時ファイル、キャッシュされたパッケージに影響を与えます。nukebuildディレクトリは除外されます。

## バッチ種別

ビルドターゲット / クリーンアップ処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（ビルドターゲット実行時または手動） |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動 / 依存ターゲットの実行時 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Nukeビルドシステム | _build.csprojがビルド済みであること |
| .NET SDK | 適切なバージョンがインストール済み |

### 実行可否判定

- 常に実行可能（対象ディレクトリが存在しない場合でも正常終了）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | このターゲットは入力パラメータを受け取りません |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| BuildParameters | C#クラス | ビルド設定（ディレクトリパス等）|

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| コンソール | ログ | 削除・クリーンアップされたディレクトリの情報 |

### 出力ファイル仕様

本ターゲットはファイル出力を行いません（ファイル削除のみ）。

## 処理フロー

### 処理シーケンス

```
1. ビルドディレクトリの削除
   └─ プロジェクト内のすべてのbin/objディレクトリを削除（nukebuild除く）
   └─ node_modulesディレクトリを削除
2. 成果物ディレクトリのクリーンアップ
   └─ artifacts/ディレクトリをクリーンアップ
3. NuGet中間ディレクトリのクリーンアップ
   └─ build-intermediate/nuget/をクリーンアップ
4. NuGet最終ディレクトリのクリーンアップ
   └─ artifacts/nuget/をクリーンアップ
5. ZIPディレクトリのクリーンアップ
   └─ artifacts/zip/をクリーンアップ
6. テスト結果ディレクトリのクリーンアップ
   └─ artifacts/test-results/をクリーンアップ
```

### フローチャート

```mermaid
flowchart TD
    A[Cleanターゲット開始] --> B[ビルドディレクトリ取得]
    B --> C[各bin/objディレクトリを削除]
    C --> D[ArtifactsDirをクリーンアップ]
    D --> E[NugetIntermediateRootをクリーンアップ]
    E --> F[NugetRootをクリーンアップ]
    F --> G[ZipRootをクリーンアップ]
    G --> H[TestResultsRootをクリーンアップ]
    H --> I[Cleanターゲット終了]
```

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

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

本バッチはデータベース操作を行いません。

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 例外 | IO例外 | ファイルがロックされている | ファイルを使用しているプロセスを終了 |
| 例外 | 権限エラー | ディレクトリへのアクセス権限がない | 権限を確認・修正 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認し、ロックされているファイルを特定
2. Visual Studio、IDE、その他のプロセスを終了
3. 再実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A |
| コミットタイミング | N/A |
| ロールバック条件 | N/A（部分的な削除が発生しても処理継続） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | プロジェクト内のbin/obj/node_modulesディレクトリ数に依存 |
| 目標処理時間 | 10秒-1分（ディスクI/O速度に依存） |
| メモリ使用量上限 | 最小限 |

## 排他制御

ファイルがロックされている場合は削除に失敗します。ビルドやIDEが実行中でないことを確認してから実行することを推奨します。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | 各ディレクトリ削除時 | "Deleting {Directory}" |
| 情報ログ | 各ディレクトリクリーンアップ時 | "Cleaning {Path}" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 非ゼロ | 手動確認 |

## 備考

- `nukebuild`ディレクトリは削除対象から除外されます（Where句で明示的にフィルタ）
- `CreateOrCleanDirectory`メソッドは、ディレクトリが存在しない場合は作成し、存在する場合は内容をクリアします
- このターゲットは他のターゲット（Compile、CompileNative）の依存関係として自動的に実行されます
- Serilog.Logを使用してログ出力を行います
