mkit_cli/commands/

clean.rs

//! `mkit clean` — remove untracked files from the worktree (like
//! `git clean`).
//!
//! Safety: this is destructive, so — matching git's `clean.requireForce`
//! default — it **refuses to delete anything** unless `-f`/`--force` is
//! given; `-n`/`--dry-run` previews instead. Without `-d`, untracked
//! *directories* are left alone (git semantics). Ignored files are kept
//! unless `-x` (also remove ignored) or `-X` (remove *only* ignored).
//!
//! Ignore matching uses the shared path-aware matcher (`.gitignore` +
//! `.mkitignore`, #256), so `-x`/`-X` honor anchored/`**`/multi-segment
//! patterns and a file under an ignored directory counts as ignored.

use std::io::Write;
use std::path::{Path, PathBuf};

use clap::Parser;
use mkit_core::ignore::{self, IgnoreList};
use mkit_core::index::Index;
use mkit_core::store::ObjectStore;

use crate::clap_shim;
use crate::exit;

#[derive(Debug, Parser)]
#[command(
    name = "mkit clean",
    about = "Remove untracked files from the worktree."
)]
#[allow(clippy::struct_excessive_bools)] // clap option flags, not a state machine
struct CleanOpts {
    /// Dry run: list what would be removed without deleting anything.
    #[arg(short = 'n', long = "dry-run")]
    dry_run: bool,
    /// Actually delete. Required (or `-n`) — clean refuses otherwise.
    #[arg(short = 'f', long)]
    force: bool,
    /// Also remove untracked directories.
    #[arg(short = 'd')]
    directories: bool,
    /// Also remove ignored files (not just untracked ones).
    #[arg(short = 'x', conflicts_with = "only_ignored")]
    ignored_too: bool,
    /// Remove ONLY ignored files.
    #[arg(short = 'X')]
    only_ignored: bool,
    /// Optional pathspecs limiting what is cleaned.
    paths: Vec<String>,
}

/// One worktree entry slated for removal.
struct Victim {
    /// Display path (git appends `/` to directories).
    display: String,
    abs: PathBuf,
    is_dir: bool,
}

#[must_use]
pub fn run(args: &[String]) -> u8 {
    let opts = match clap_shim::parse::<CleanOpts>("mkit clean", args) {
        Ok(o) => o,
        Err(code) => return code,
    };
    let cwd = match std::env::current_dir() {
        Ok(p) => p,
        Err(e) => return emit_err(&format!("cwd: {e}"), exit::NOINPUT),
    };
    let store = match ObjectStore::open(&cwd) {
        Ok(s) => s,
        Err(e) => return emit_err(&format!("not a mkit repo: {e}"), exit::GENERAL_ERROR),
    };
    // Safety: never delete without an explicit -f, mirroring git's
    // `clean.requireForce`. `-n` previews without deleting.
    if !opts.force && !opts.dry_run {
        return emit_err(
            "refusing to clean without -f (use -n to preview, -f to delete)",
            exit::GENERAL_ERROR,
        );
    }
    let _lock = match super::acquire_worktree_lock(&cwd) {
        Ok(l) => l,
        Err(code) => return code,
    };
    let index = match super::read_or_seed_index_from_head(&cwd, &store) {
        Ok(i) => i,
        Err(e) => return emit_err(&e, exit::GENERAL_ERROR),
    };
    let ignore = match ignore::load(&cwd) {
        Ok(i) => i,
        Err(e) => return emit_err(&format!("read ignore file: {e}"), exit::GENERAL_ERROR),
    };

    let mut victims: Vec<Victim> = match collect_dir(&cwd, &cwd, "", false, &index, &ignore, &opts)
    {
        Ok((_root_fully_removable, v)) => v,
        Err(e) => return emit_err(&format!("scan worktree: {e}"), exit::GENERAL_ERROR),
    };

    // Pathspec filter (repo-relative match-or-descend), if any. A `.` or
    // empty pathspec means "everything under cwd" and is skipped.
    let specs: Vec<String> = opts
        .paths
        .iter()
        .map(|p| normalize_pathspec(p))
        .filter(|s| !s.is_empty())
        .collect();
    let match_all = opts.paths.iter().any(|p| {
        let n = normalize_pathspec(p);
        n.is_empty()
    });
    if !specs.is_empty() && !match_all {
        victims.retain(|v| {
            let p = v.display.strip_suffix('/').unwrap_or(&v.display);
            specs
                .iter()
                .any(|s| super::index_path_matches_or_descends(p, s))
        });
    }

    // Deterministic, git-like ordering.
    victims.sort_by(|a, b| a.display.cmp(&b.display));

    let mut out = std::io::stdout().lock();
    for v in &victims {
        if opts.dry_run {
            let _ = writeln!(out, "Would remove {}", v.display);
            continue;
        }
        if let Err(e) = remove(&v.abs, v.is_dir) {
            return emit_err(&format!("remove {}: {e}", v.display), exit::GENERAL_ERROR);
        }
        let _ = writeln!(out, "Removing {}", v.display);
    }
    exit::OK
}

/// Recursively gather removal candidates under `dir`. Returns
/// `(fully_removable, victims)`: `fully_removable` is true when nothing
/// inside the directory survives a clean, so a caller may collapse the
/// whole subtree to a single `dir/` victim; otherwise `victims` are the
/// individual removable entries within it.
///
/// Matches git: a **nested repository** (a subdirectory containing
/// `.mkit`/`.git`) is left untouched — git only removes one with the
/// double-force `-ff`, which mkit doesn't offer. **Ignored files are
/// kept** (unless `-x`) and keep their parent directory alive. So a
/// directory is removed wholesale only when every entry under it is itself
/// removable.
fn collect_dir(
    root: &Path,
    dir: &Path,
    prefix: &str,
    parent_ignored: bool,
    index: &Index,
    ignore: &IgnoreList,
    opts: &CleanOpts,
) -> std::io::Result<(bool, Vec<Victim>)> {
    // Nested-repo protection. The repo root always has its own `.mkit`, so
    // only guard SUBdirectories (prefix non-empty).
    if !prefix.is_empty() && (dir.join(".mkit").exists() || dir.join(".git").exists()) {
        return Ok((false, Vec::new()));
    }
    let read = match std::fs::read_dir(dir) {
        Ok(r) => r,
        Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok((true, Vec::new())),
        Err(e) => return Err(e),
    };
    let mut victims: Vec<Victim> = Vec::new();
    let mut fully_removable = true;
    for entry in read {
        let entry = entry?;
        let name = entry.file_name();
        let Some(name) = name.to_str() else {
            fully_removable = false;
            continue;
        };
        if name.eq_ignore_ascii_case(".mkit") || name.eq_ignore_ascii_case(".git") {
            fully_removable = false; // repo metadata stays
            continue;
        }
        let path = if prefix.is_empty() {
            name.to_string()
        } else {
            format!("{prefix}/{name}")
        };
        let abs = root.join(&path);
        // A symlink is treated as a file (never followed/recursed).
        let is_dir = std::fs::symlink_metadata(&abs)?.is_dir();
        // A path under an ignored directory is ignored too (git "can't
        // re-include under an excluded dir"); OR in the inherited bit. This
        // must be computed BEFORE the tracked check so a tracked-but-ignored
        // directory (e.g. node_modules/ with a tracked file inside) still
        // propagates the ignored bit to its untracked descendants.
        let ignored = parent_ignored || ignore.is_ignored(&path, is_dir);

        // A directory shadowing a path tracked as a *file* is not untracked
        // content: git reports only the tracked-side deletion and suppresses
        // the directory's contents (#288). Skip the whole subtree — this must
        // precede the `index_tracks_path_or_descendant` branch below, which
        // would otherwise treat `f` as a tracked-descendant and descend into
        // `f/`, deleting `f/child`. The dir stays (shadows a tracked path), so
        // clear `fully_removable`.
        if is_dir && index.has_tracked_file_at(&path) {
            fully_removable = false;
            continue;
        }

        if super::index_tracks_path_or_descendant(index, &path) {
            // Tracked content keeps the dir alive; descend into a tracked
            // directory to clean any untracked files inside it, carrying the
            // ignored bit so ignored untracked descendants are kept.
            fully_removable = false;
            if is_dir {
                let (_full, sub) = collect_dir(root, &abs, &path, ignored, index, ignore, opts)?;
                victims.extend(sub);
            }
            continue;
        }

        // Untracked. `-X` keeps only ignored entries; otherwise keep
        // non-ignored entries and ignored ones only with `-x`.
        let include = if opts.only_ignored {
            ignored
        } else {
            !ignored || opts.ignored_too
        };

        if is_dir {
            if !opts.directories {
                fully_removable = false; // untracked dirs need -d
                continue;
            }
            let (sub_full, sub) = collect_dir(root, &abs, &path, ignored, index, ignore, opts)?;
            if sub_full && include {
                // The whole subtree is removable → one `dir/` victim.
                victims.push(Victim {
                    display: format!("{path}/"),
                    abs,
                    is_dir: true,
                });
            } else {
                // Some entries survive (ignored / nested repo) → keep the
                // directory, remove only its removable contents.
                fully_removable = false;
                victims.extend(sub);
            }
        } else if include {
            victims.push(Victim {
                display: path,
                abs,
                is_dir: false,
            });
        } else {
            fully_removable = false; // kept (ignored) file → dir survives
        }
    }
    Ok((fully_removable, victims))
}

fn remove(abs: &Path, is_dir: bool) -> std::io::Result<()> {
    if is_dir {
        std::fs::remove_dir_all(abs)
    } else {
        std::fs::remove_file(abs)
    }
}

/// Normalize a pathspec to the index path form: strip a leading `./`,
/// collapse `\\` to `/`, drop a trailing `/`. The cwd itself (`.` or `./`)
/// normalizes to the empty string, meaning "everything under cwd".
fn normalize_pathspec(spec: &str) -> String {
    let s = spec.replace('\\', "/");
    let s = s.strip_prefix("./").unwrap_or(&s);
    let s = s.strip_suffix('/').unwrap_or(s);
    if s == "." {
        String::new()
    } else {
        s.to_string()
    }
}

fn emit_err(msg: &str, code: u8) -> u8 {
    let mut stderr = std::io::stderr().lock();
    let _ = writeln!(stderr, "error: {msg}");
    code
}