Skip to content

Free, open-source macOS cleaner. CleanMyMac alternative with zero telemetry. Native SwiftUI, scheduled auto-cleaning, Xcode/Homebrew/system cache cleanup. MIT licensed.

5.8 KB
Raw Blame
import ArgumentParser
import Foundation

struct Purge: ParsableCommand {
    static let configuration = CommandConfiguration(
        abstract: "Find removable build artifacts inside project folders (node_modules, target, .venv, …).",
        discussion: """
        With no path, scans ~/Projects, ~/Code, ~/dev, ~/GitHub, ~/Workspace.
        Interactive review starts empty so recent and older artifacts are both selectable.
          puremac purge                 Scan the default project folders
          puremac purge ~/Work/app      Scan a specific folder

        Finishing the selector only opens an exact deletion review; a separate confirmation defaults to No. --plain uses a numbered selector with ranges, all, and none. --force removes only artifacts older than the configured threshold without either prompt. --dry-run and --json never delete or open a selector.
        """
    )

    @Argument(help: "Folder(s) to scan. Omit to scan the default project locations.")
    var paths: [String] = []

    @Option(name: .customLong("older-than"), help: "Age threshold used by --force and read-only reports (default 7, or config).")
    var olderThanDays: Int = -1

    @Flag(name: .long, help: "Remove age-selected artifacts without review or confirmation.")
    var force = false

    @Flag(name: .customLong("dry-run"), help: "Scan and report only; never delete.")
    var dryRun = false

    @Flag(name: .long, help: "Emit machine-readable JSON and exit (never deletes).")
    var json = false

    @Flag(name: .long, help: "Use a numbered line-based selector instead of the fullscreen review.")
    var plain = false

    func validate() throws {
        if olderThanDays != -1 && !(0...3650).contains(olderThanDays) {
            throw ValidationError("--older-than must be between 0 and 3650 days.")
        }
        for p in paths {
            let v = Safety.isValidScanRoot(p)
            if !v.ok { throw ValidationError(v.reason ?? "invalid path") }
        }
    }

    func run() throws {
        let mode = CleanupCommandPolicy.mode(
            force: force,
            dryRun: dryRun,
            json: json,
            plain: plain
        )
        guard mode != .unavailable else {
            throw ValidationError("Interactive review requires a terminal. Re-run with --force to remove the age-selected artifacts, or use --dry-run or --json for a read-only report.")
        }

        let ignore = try IgnoreStore(fileURL: AppPaths.ignoreFile)
        let days = try resolvedDays()
        let roots = paths.isEmpty
            ? Purger.defaultRoots
            : paths.map { Safety.absolutePath($0) }

        if !json { Term.err(Term.dim("Scanning " + roots.map { Render.shorten($0) }.joined(separator: ", ") + " …")) }
        let cat = Purger.scan(roots: roots, olderThanDays: days, ignore: ignore)

        if json { print(try JSONReport.string([cat])); return }

        if cat.groups.isEmpty {
            print(Term.green("No project artifacts found in readable locations."))
            return
        }

        if dryRun {
            renderScan(cat, days: days)
            let selected = cat.selectedItems
            let out = Cleaner.remove(selected, ignore: ignore, dryRun: true)
            Render.cleanupSummary(out, dryRun: true)
            return
        }

        let reviewed: [CategoryScan]
        switch mode {
        case .forced:
            reviewed = [cat]
            renderScan(cat, days: days)
        case .fullscreen:
            guard let selection = try InteractiveReview.select([cat], title: "Choose project artifacts") else {
                print(Term.dim("Cancelled. Nothing removed."))
                return
            }
            reviewed = selection
        case .plain:
            guard let selection = try PlainSelectionReview.select([cat], title: "Choose project artifacts") else {
                print(Term.dim("Cancelled. Nothing removed."))
                return
            }
            reviewed = selection
        case .reportOnly, .unavailable:
            return
        }

        let selected = reviewed.flatMap { $0.selectedItems }
        if selected.isEmpty { print(Term.dim("\nNo artifacts selected. Nothing removed.")); return }

        if mode != .forced {
            Render.deletionReview(reviewed)
            let total = ByteCount.human(selected.reduce(Int64(0)) { $0 + $1.sizeBytes })
            guard Term.confirm("Remove \(selected.count) artifacts (\(total))?", default: false) else {
                print(Term.dim("Cancelled. Nothing removed."))
                return
            }
        }
        let out = Cleaner.remove(selected, ignore: ignore, dryRun: false)
        Render.cleanupSummary(out, dryRun: false)
        if out.hadFailures { throw ExitCode.failure }
    }

    private func resolvedDays() throws -> Int {
        if olderThanDays >= 0 { return olderThanDays }
        let config = try ConfigStore(fileURL: AppPaths.configFile)
        if let v = config.values["purge.older_than_days"], let n = Int(v), (0...3650).contains(n) { return n }
        return 7
    }

    private func renderScan(_ cat: CategoryScan, days: Int) {
        let projectCount = cat.groups.count
        print("")
        print(Term.bold("Found \(ByteCount.human(cat.allBytes)) across \(projectCount) project\(projectCount == 1 ? "" : "s")"))
        for group in cat.groups {
            print("")
            print("  \(Term.cyan(group.tool))  \(Term.dim(ByteCount.human(group.allBytes)))")
            for item in group.items {
                let mark = item.selected ? Term.green("✓") : Term.dim("·")
                let recent = item.selected ? "" : Term.dim("  recent")
                print("    \(mark) \(Render.sizeCol(item.sizeBytes)) \(Render.shorten(item.path))\(recent)")
            }
        }
        print("")
        print(Term.dim("Artifacts newer than \(days) days are shown but left unchecked."))
    }
}