# バッチ設計書 7-doom gc

## 概要

本ドキュメントは、孤立したパッケージとリポジトリを削除し、コンパクト化するCLIコマンド`doom gc`の設計仕様を定義するものである。

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

`doom gc`（garbage collection）は、Doom Emacsの不要なパッケージデータを削除し、ディスクスペースを回復するためのクリーンアップコマンドである。孤立したパッケージビルド、未使用のGitリポジトリ、古いELNバイトコード、ELPAパッケージを削除し、さらにリポジトリをリグラフトしてサイズを縮小する。

**業務上の目的・背景**：Doom Emacsを長期間使用していると、パッケージの追加/削除やアップデートにより、不要なデータが蓄積される。特にGitリポジトリは履歴を含むため大きくなりやすい。`doom gc`は、これらの不要データを安全に削除し、Doomインストールをスリムに保つ。定期的な実行により、ディスクスペースの効率的な利用が可能になる。

**バッチの実行タイミング**：以下の場合に実行が推奨される：
- `doom sync`の内部から自動的に呼び出される
- ディスクスペースを回復したい時
- パッケージを大量に削除した後
- 定期的なメンテナンスとして

**主要な処理内容**：
1. 孤立したパッケージビルドの削除（straight/build/）
2. ELPAパッケージの完全削除（一時的なパッケージ扱い）
3. 未使用のGitリポジトリの削除（straight/repos/）
4. Gitリポジトリのリグラフト（履歴の圧縮）
5. 古いELNバイトコードの削除（native-compile使用時）

**前後の処理との関連**：`doom sync`の内部で呼び出される。単独でも実行可能。

**影響範囲**：straight/build/、straight/repos/、package-user-dir（ELPA）、ELNキャッシュディレクトリ。

## バッチ種別

ガベージコレクション / ディスククリーンアップ

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（定期メンテナンス推奨） |
| 実行時刻 | ユーザー任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動 または doom sync からの呼び出し |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Doom Emacs インストール済み | パッケージキャッシュが存在すること |
| Git 利用可能 | リポジトリ操作のために必要 |

### 実行可否判定

1. straight-prune-build-cache が実行可能であること
2. 対象ディレクトリ（straight/build/, straight/repos/）が存在すること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| -b, --no-builds | フラグ | No | false | ビルドされたパッケージを削除しない |
| -p, --no-elpa | フラグ | No | false | ELPAパッケージを削除しない |
| -r, --no-repos | フラグ | No | false | 未使用のリポジトリを削除しない |
| -e, --no-eln | フラグ | No | false | 古いELNバイトコードを削除しない |
| -g, --no-regraft | フラグ | No | false | Gitリポジトリをリグラフトしない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| straight--profile-cache | ハッシュテーブル | 有効なパッケージビルドの一覧 |
| straight--repo-cache | ハッシュテーブル | 有効なリポジトリの一覧 |
| straight/build/ | ディレクトリ | ビルドされたパッケージ |
| straight/repos/ | ディレクトリ | クローンされたリポジトリ |
| package-user-dir | ディレクトリ | ELPAパッケージ |
| doom-packages--eln-output-path | ディレクトリ | ELNバイトコード |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 削除/圧縮の進捗とステータス |

### 出力ファイル仕様

本コマンドはファイルを削除するため、出力ファイルは生成しない。

## 処理フロー

### 処理シーケンス

```
1. 初期化
   └─ doom-initialize-packages の呼び出し
   └─ doom-packages--barf-if-incomplete のチェック
   └─ straight-prune-build-cache の実行

2. 削除対象の特定
   └─ builds-to-purge: profile-cache にないビルド
   └─ repos-to-purge: repo-cache にないリポジトリ
   └─ repos-to-regraft: repo-cache にあるリポジトリ

3. ビルド削除（-b なし）
   └─ 各ビルドディレクトリを再帰的に削除
   └─ 削除結果をログ出力

4. ELPA削除（-p なし）
   └─ package-user-dir 内の全ファイル/ディレクトリを削除

5. リポジトリ削除（-r なし）
   └─ 未使用リポジトリを再帰的に削除
   └─ modified ファイルも削除

6. リポジトリリグラフト（-g なし）
   └─ git reset --hard, git clean -ffd
   └─ git replace --graft HEAD
   └─ git reflog expire, git gc --prune=now
   └─ サイズ変化をログ出力

7. ELN削除（-e なし、native-compile時）
   └─ 現在のバージョン以外のELNディレクトリを削除
```

### フローチャート

```mermaid
flowchart TD
    A[doom gc 開始] --> B[パッケージ初期化]
    B --> C[ビルドキャッシュ整理]
    C --> D{-b オプション?}
    D -->|No| E[孤立ビルド削除]
    D -->|Yes| F[ビルド削除スキップ]
    E --> G{-p オプション?}
    F --> G
    G -->|No| H[ELPAパッケージ削除]
    G -->|Yes| I[ELPA削除スキップ]
    H --> J{-r オプション?}
    I --> J
    J -->|No| K[孤立リポジトリ削除]
    J -->|Yes| L[リポジトリ削除スキップ]
    K --> M{-g オプション?}
    L --> M
    M -->|No| N[リポジトリリグラフト]
    M -->|Yes| O[リグラフトスキップ]
    N --> P{native-compile有効?}
    O --> P
    P -->|Yes| Q{-e オプション?}
    P -->|No| R[終了]
    Q -->|No| S[古いELN削除]
    Q -->|Yes| R
    S --> R
```

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

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

本コマンドはデータベースを使用しない。

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

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

データベース操作は行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非ゼロ | 削除失敗 | ディレクトリ削除が失敗 | パーミッション確認、ファイル使用中確認 |
| 非ゼロ | Git操作失敗 | リグラフト操作が失敗 | Gitの状態確認 |
| 警告 | ローカルリポジトリ | リポジトリが straight-base-dir 外 | 手動確認 |

### リトライ仕様

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

### 障害時対応

1. 削除に失敗したファイル/ディレクトリを手動確認
2. 使用中のファイルがあれば、Emacsを終了してから再実行
3. パーミッションエラーの場合、適切な権限で実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 各削除操作は独立 |
| コミットタイミング | 各操作完了時 |
| ロールバック条件 | ロールバックなし（削除は不可逆） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | リポジトリ/ビルド数に依存 |
| 目標処理時間 | 数秒〜数分（リグラフト有無による） |
| メモリ使用量上限 | Emacsプロセス標準使用量 |

## 排他制御

- 同時に複数の`doom gc`を実行することは推奨されない
- Emacsが実行中でも動作するが、パッケージ使用中の削除に注意

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | コマンド開始時 | "Purging orphaned packages (for the emperor)..." |
| 進捗ログ | 各削除時 | "Purged build/XXX", "Purged repos/XXX" |
| 成功ログ | リグラフト成功時 | サイズ変化（before/after） |
| スキップログ | スキップ時 | "Skipping builds", "No builds to purge" 等 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | ベンチマーク表示 | 標準出力 |
| 削除件数 | 各操作完了時 | 標準出力 |

## 備考

- "for the emperor" はWarhammer 40kの参照（開発者のユーモア）
- リグラフトは`git replace --graft HEAD`でルートコミットのみを残す
- ELPAパッケージは「一時的」として扱われ、全て削除される
- `doom sync`から呼び出される場合、`-begpr`オプションで制限される（--gc時のみフル実行）
- `:benchmark t`により処理時間が自動的に計測される
- `:group 'emacs`でEmacs関連コマンドグループに分類
