Add a new clean target / 新しいクリーンターゲットの追加方法

🇺🇸 English

Steps to add a new cache-cleaning target to sasurahime.

1. Open an issue first

Before writing any code, open an Issue (or comment on an existing PR) to discuss the proposal. We need to confirm:

Title: feat: support <tool> cache cleaning
Body:  - Tool name / version
       - Cache directory path(s)
       - How to clean
       - Safety concerns

2. Implementation

There are two paths depending on the cleaner’s complexity.

Most cleaners (simple { dry_run: bool } variants with a single factory function) use the define_cleaners! macro in src/main.rs. Adding one requires touching 3 places:

  1. Create src/cleaners/<name>.rs implementing the Cleaner trait
  2. Register pub mod <name>; in src/cleaners/mod.rs
  3. Add one line to the define_cleaners! invocation in src/main.rs:
// In src/main.rs, inside the define_cleaners! block:
MyNewTarget : "my-new-target" => "Description of what this cleans";
(|home, _config| cleaners::my_new_target::MyNewTargetCleaner::new(home, Box::new(SystemCommandRunner))),

That’s it. The macro auto-generates:

No manual edits to CleanTarget, SUPPORTED_TARGETS, all_cleaners(), or main() match are needed for standard cleaners.

Path B: Special dispatch cleaner

Some cleaners need custom dispatch logic beyond what the macro provides:

Reason Examples
Extra CLI flags beyond --dry-run Logs (--keep-days), LibraryLogs (--all / interactive)
Composite (runs multiple cleaners) Caches
Pre-check before cleaning Xcode (running process detection)
Completely different behavior Trash (scan-only, warns on clean)

For these, follow Path A above plus add manual dispatch in src/main.rs:

  1. The macro handles the enum variant and basic registration
  2. Add a match arm inside the special-targets block in main() (see existing handlers for Logs, Xcode, Caches, Trash, and LibraryLogs)
// In src/main.rs, inside the if matches!(target, ...) { match target { ... } } block:
CleanTarget::MySpecialTarget { dry_run } => {
    let cleaner = cleaners::my_target::MyTargetCleaner::new(&home, Box::new(SystemCommandRunner));
    run_clean_target("my-target", |dry| cleaner.clean(dry), dry_run)?;
}
  1. Add the variant name to the matches!() check and to the impl CleanTarget methods (command_name(), dry_run()).

Both paths

  1. Add E2E test in tests/<name>.rs; add unit tests as needed
  2. Pass quality gates:
cargo fmt --check && cargo clippy --tests -- -D warnings && cargo test

See existing cleaners (uv.rs for a standard cleaner, library_logs.rs for a special-dispatch cleaner) for reference.

🇯🇵 日本語

sasurahime に新しいキャッシュクリーンターゲットを追加する手順を説明します。

1. まず Issue を開く

コードを書く前に、Issue を開いて（または既存の PR にコメントして）提案を議論してください。以下を確認します：

Title: feat: support <tool> cache cleaning
Body:  - ツール名 / バージョン
       - キャッシュディレクトリのパス
       - クリーン方法
       - 安全性に関する懸念

2. 実装

クリーナーの複雑さに応じて 2 つのパスがあります。

パス A：標準クリーナー（推奨）

ほとんどのクリーナー（シンプルな { dry_run: bool } 型で単一のファクトリ関数を持つもの）は src/main.rs の define_cleaners! マクロを使用します。追加には 3 箇所 の変更が必要です：

  1. Cleaner トレイトを実装した src/cleaners/<name>.rs を 作成
  2. src/cleaners/mod.rs に pub mod <name>; を 登録
  3. src/main.rs の define_cleaners! 呼び出しに 1 行追加：
// src/main.rs の define_cleaners! ブロック内：
MyNewTarget : "my-new-target" => "このクリーナーの説明";
(|home, _config| cleaners::my_new_target::MyNewTargetCleaner::new(home, Box::new(SystemCommandRunner))),

これだけです。マクロが自動生成するもの：

標準クリーナーでは CleanTarget、SUPPORTED_TARGETS、all_cleaners()、main() のマッチへの手動編集は不要です。

パス B：特別ディスパッチクリーナー

一部のクリーナーはマクロが提供する以上のカスタムディスパッチロジックが必要です：

理由 例
--dry-run 以外の追加 CLI フラグ Logs（--keep-days）、LibraryLogs（--all / インタラクティブ）
複合（複数クリーナーを実行） Caches
クリーン前の事前チェック Xcode（実行中プロセスの検出）
完全に異なる動作 Trash（スキャンのみ、クリーン時に警告）

これらの場合は、上記のパス A に従った上で src/main.rs に 手動ディスパッチ を追加します：

  1. マクロが列挙子と基本登録を処理します
  2. main() の special-targets ブロック内にマッチアームを追加します（Logs、Xcode、Caches、Trash、LibraryLogs の既存ハンドラを参照）
// src/main.rs の if matches!(target, ...) { match target { ... } } ブロック内：
CleanTarget::MySpecialTarget { dry_run } => {
    let cleaner = cleaners::my_target::MyTargetCleaner::new(&home, Box::new(SystemCommandRunner));
    run_clean_target("my-target", |dry| cleaner.clean(dry), dry_run)?;
}
  1. matches!() チェックと impl CleanTarget のメソッド（command_name()、dry_run()）に列挙子名を追加します。

両方のパスに共通

  1. tests/<name>.rs に E2E テストを追加し、必要に応じてユニットテストを追加します。
  2. 品質ゲートを通過させます：
cargo fmt --check && cargo clippy --tests -- -D warnings && cargo test

参考として、既存のクリーナー（標準クリーナーは uv.rs、特別ディスパッチクリーナーは library_logs.rs）を参照してください。