commit 72b6a13216fba107f4a5478cf2bcf62091078257 Author: mace Date: Sun Apr 12 13:01:48 2026 +0200 cargo cleanup tool (plugin) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ea8c4bf --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/target diff --git a/Cargo.lock b/Cargo.lock new file mode 100644 index 0000000..67cd2b6 --- /dev/null +++ b/Cargo.lock @@ -0,0 +1,222 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 4 + +[[package]] +name = "anstream" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "824a212faf96e9acacdbd09febd34438f8f711fb84e09a8916013cd7815ca28d" +dependencies = [ + "anstyle", + "anstyle-parse", + "anstyle-query", + "anstyle-wincon", + "colorchoice", + "is_terminal_polyfill", + "utf8parse", +] + +[[package]] +name = "anstyle" +version = "1.0.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "940b3a0ca603d1eade50a4846a2afffd5ef57a9feac2c0e2ec2e14f9ead76000" + +[[package]] +name = "anstyle-parse" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "52ce7f38b242319f7cabaa6813055467063ecdc9d355bbb4ce0c68908cd8130e" +dependencies = [ + "utf8parse", +] + +[[package]] +name = "anstyle-query" +version = "1.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "40c48f72fd53cd289104fc64099abca73db4166ad86ea0b4341abe65af83dadc" +dependencies = [ + "windows-sys", +] + +[[package]] +name = "anstyle-wincon" +version = "3.0.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "291e6a250ff86cd4a820112fb8898808a366d8f9f58ce16d1f538353ad55747d" +dependencies = [ + "anstyle", + "once_cell_polyfill", + "windows-sys", +] + +[[package]] +name = "anyhow" +version = "1.0.102" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f202df86484c868dbad7eaa557ef785d5c66295e41b460ef922eca0723b842c" + +[[package]] +name = "clap" +version = "4.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b193af5b67834b676abd72466a96c1024e6a6ad978a1f484bd90b85c94041351" +dependencies = [ + "clap_builder", + "clap_derive", +] + +[[package]] +name = "clap_builder" +version = "4.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "714a53001bf66416adb0e2ef5ac857140e7dc3a0c48fb28b2f10762fc4b5069f" +dependencies = [ + "anstream", + "anstyle", + "clap_lex", + "strsim", +] + +[[package]] +name = "clap_derive" +version = "4.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1110bd8a634a1ab8cb04345d8d878267d57c3cf1b38d91b71af6686408bbca6a" +dependencies = [ + "heck", + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "clap_lex" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c8d4a3bb8b1e0c1050499d1815f5ab16d04f0959b233085fb31653fbfc9d98f9" + +[[package]] +name = "cleanup" +version = "0.1.0" +dependencies = [ + "anyhow", + "clap", + "walkdir", +] + +[[package]] +name = "colorchoice" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d07550c9036bf2ae0c684c4297d503f838287c83c53686d05370d0e139ae570" + +[[package]] +name = "heck" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea" + +[[package]] +name = "is_terminal_polyfill" +version = "1.70.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a6cb138bb79a146c1bd460005623e142ef0181e3d0219cb493e02f7d08a35695" + +[[package]] +name = "once_cell_polyfill" +version = "1.70.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "384b8ab6d37215f3c5301a95a4accb5d64aa607f1fcb26a11b5303878451b4fe" + +[[package]] +name = "proc-macro2" +version = "1.0.106" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "quote" +version = "1.0.45" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "same-file" +version = "1.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93fc1dc3aaa9bfed95e02e6eadabb4baf7e3078b0bd1b4d7b6b0b68378900502" +dependencies = [ + "winapi-util", +] + +[[package]] +name = "strsim" +version = "0.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" + +[[package]] +name = "syn" +version = "2.0.117" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "unicode-ident" +version = "1.0.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75" + +[[package]] +name = "utf8parse" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821" + +[[package]] +name = "walkdir" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29790946404f91d9c5d06f9874efddea1dc06c5efe94541a7d6863108e3a5e4b" +dependencies = [ + "same-file", + "winapi-util", +] + +[[package]] +name = "winapi-util" +version = "0.1.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c2a7b1c03c876122aa43f3020e6c3c3ee5c05081c9a00739faf7503aeba10d22" +dependencies = [ + "windows-sys", +] + +[[package]] +name = "windows-link" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5" + +[[package]] +name = "windows-sys" +version = "0.61.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc" +dependencies = [ + "windows-link", +] diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..ac68b71 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,13 @@ +[package] +name = "cleanup" +version = "0.1.0" +edition = "2024" + +[dependencies] +anyhow = "1.0.102" +clap = { version = "4.6.0", features = ["derive"] } +walkdir = "2.5.0" + +[[bin]] +name = "cargo-cleanup" +path = "src/main.rs" diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..42b4b8b --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,118 @@ +use std::{ + path::{Path, PathBuf}, + process::Command, +}; + +use anyhow::Result; +use walkdir::WalkDir; + +#[derive(Default)] +pub struct Slimmer { + pub dry_run: bool, +} + +pub struct Report { + pub output: String, +} + +impl Slimmer { + #[must_use] + pub fn new() -> Self { + Self::default() + } + + pub fn cleanup(&self, path: impl AsRef) -> Result { + let mut output = String::new(); + for target in manifests(path)? { + let mut command = self.cargo_clean_cmd(&target); + let cmd_output = command.output()?; + output.push_str(&summary(target, &cmd_output)); + } + Ok(Report { output }) + } + + fn cargo_clean_cmd(&self, target: &PathBuf) -> Command { + let mut command = Command::new("cargo"); + command.arg("clean"); + command.arg("--manifest-path"); + command.arg(target); + + if self.dry_run { + command.arg("--dry-run"); + } + + command + } +} + +fn summary(target: impl AsRef, cmd_output: &std::process::Output) -> String { + format!( + "{}: {}", + target.as_ref().parent().unwrap().display(), + String::from_utf8_lossy(&cmd_output.stderr).trim_start() + ) +} + +fn manifests(path: impl AsRef) -> Result> { + let mut targets: Vec = Vec::new(); + let tmp = WalkDir::new(path) + .into_iter() + .filter_entry(|e| !e.path().ends_with("target/package")); + for entry in tmp { + let entry = entry?; + if entry.file_name() == "Cargo.toml" { + targets.push(entry.into_path()); + } + } + + Ok(targets) +} + +#[cfg(test)] +mod tests { + use std::process::{ExitStatus, Output}; + + use super::*; + #[test] + fn manifestes_returns_toml_paths() { + let mut manifest = manifests("tests/data").unwrap(); + manifest.sort(); + assert_eq!( + manifest, + vec![ + PathBuf::from("tests/data/proj_1/Cargo.toml"), + PathBuf::from("tests/data/proj_2/Cargo.toml"), + PathBuf::from("tests/data/proj_3/Cargo.toml"), + ], + "wrong path", + ); + } + + #[test] + fn cargo_clean_cmd_returns_correct_command() { + let slimmer = Slimmer::new(); + let cmd = slimmer.cargo_clean_cmd(&PathBuf::from("tests/data/proj_1/Cargo.toml")); + assert_eq!(cmd.get_program(), "cargo", "wrong program"); + assert_eq!( + cmd.get_args().collect::>(), + ["clean", "--manifest-path", "tests/data/proj_1/Cargo.toml"], + "wrong args" + ) + } + + #[test] + fn summary_returns_correct_string() { + let cmd_output = summary( + PathBuf::from("./target/Cargo.toml"), + &Output { + stdout: Vec::new(), + stderr: String::from(" Removed 2 files, 1.6MiB total\n").into_bytes(), + status: ExitStatus::default(), + }, + ); + assert_eq!( + cmd_output, "./target: Removed 2 files, 1.6MiB total\n", + "wrong formatting" + ); + } +} diff --git a/src/main.rs b/src/main.rs new file mode 100644 index 0000000..8ac9550 --- /dev/null +++ b/src/main.rs @@ -0,0 +1,35 @@ +use anyhow::Result; +use clap::Parser; +use cleanup::{Slimmer}; + +#[derive(Debug, Parser)] +#[command(bin_name = "cargo")] +enum CargoCommand { + Slim(Args), +} + +#[derive(clap::Args, Debug)] +/// Runs `cargo clean` recursively to save disk space by deleting build +/// artifacts. +struct Args { + #[arg(default_value = ".")] + paths: Vec, + #[arg(long)] + dry_run: bool, +} + +fn main() -> Result<()> { + let CargoCommand::Slim(args) = CargoCommand::parse(); + let mut slimmer = Slimmer::new(); + + if args.dry_run { + slimmer.dry_run = true; + } + + for path in &args.paths { + let output = slimmer.cleanup(path)?; + println!("{}", output.output); + } + + Ok(()) +} diff --git a/tests/data/proj_1/Cargo.toml b/tests/data/proj_1/Cargo.toml new file mode 100644 index 0000000..1e2c850 --- /dev/null +++ b/tests/data/proj_1/Cargo.toml @@ -0,0 +1,6 @@ +[package] +name = "proj_1" +version = "0.1.0" +edition = "2024" + +[dependencies] diff --git a/tests/data/proj_1/src/main.rs b/tests/data/proj_1/src/main.rs new file mode 100644 index 0000000..e7a11a9 --- /dev/null +++ b/tests/data/proj_1/src/main.rs @@ -0,0 +1,3 @@ +fn main() { + println!("Hello, world!"); +} diff --git a/tests/data/proj_2/Cargo.toml b/tests/data/proj_2/Cargo.toml new file mode 100644 index 0000000..8ff59aa --- /dev/null +++ b/tests/data/proj_2/Cargo.toml @@ -0,0 +1,6 @@ +[package] +name = "proj_2" +version = "0.1.0" +edition = "2024" + +[dependencies] diff --git a/tests/data/proj_2/src/main.rs b/tests/data/proj_2/src/main.rs new file mode 100644 index 0000000..e7a11a9 --- /dev/null +++ b/tests/data/proj_2/src/main.rs @@ -0,0 +1,3 @@ +fn main() { + println!("Hello, world!"); +} diff --git a/tests/data/proj_3/Cargo.toml b/tests/data/proj_3/Cargo.toml new file mode 100644 index 0000000..89c576b --- /dev/null +++ b/tests/data/proj_3/Cargo.toml @@ -0,0 +1,6 @@ +[package] +name = "proj_3" +version = "0.1.0" +edition = "2024" + +[dependencies] diff --git a/tests/data/proj_3/src/main.rs b/tests/data/proj_3/src/main.rs new file mode 100644 index 0000000..e7a11a9 --- /dev/null +++ b/tests/data/proj_3/src/main.rs @@ -0,0 +1,3 @@ +fn main() { + println!("Hello, world!"); +}