Add a summary to cargo clean.

This adds a summary at the end when `cargo clean` finishes that displays
how many files and bytes were removed.

Author: ehuss

crates/cargo-test-support/src/compare.rs

@@ -206,6 +206,7 @@ fn substitute_macros(input: &str) -> String {
         ("[UPDATING]", "    Updating"),
         ("[ADDING]", "      Adding"),
         ("[REMOVING]", "    Removing"),
+        ("[REMOVED]", "     Removed"),
         ("[DOCTEST]", "   Doc-tests"),
         ("[PACKAGING]", "   Packaging"),
         ("[PACKAGED]", "    Packaged"),

src/cargo/ops/cargo_clean.rs

@@ -5,7 +5,7 @@ use crate::ops;
 use crate::util::edit_distance;
 use crate::util::errors::CargoResult;
 use crate::util::interning::InternedString;
-use crate::util::{Config, Progress, ProgressStyle};
+use crate::util::{human_readable_bytes, Config, Progress, ProgressStyle};
 use anyhow::bail;
 use cargo_util::paths;
 use std::fs;
@@ -31,6 +31,8 @@ pub struct CleanContext<'cfg> {
     pub config: &'cfg Config,
     progress: Box<dyn CleaningProgressBar + 'cfg>,
     pub dry_run: bool,
+    num_files_folders_cleaned: u64,
+    total_bytes_removed: u64,
 }
 
 /// Cleans various caches.
@@ -76,6 +78,7 @@ pub fn clean(ws: &Workspace<'_>, opts: &CleanOptions<'_>) -> CargoResult<()> {
         }
     }
 
+    ctx.display_summary()?;
     Ok(())
 }
 
@@ -267,6 +270,8 @@ impl<'cfg> CleanContext<'cfg> {
             config,
             progress: Box::new(progress),
             dry_run: false,
+            num_files_folders_cleaned: 0,
+            total_bytes_removed: 0,
         }
     }
 
@@ -340,20 +345,28 @@ impl<'cfg> CleanContext<'cfg> {
         }
         self.progress.display_now()?;
 
-        let rm_file = |path: &Path| {
+        let mut rm_file = |path: &Path, meta: Result<std::fs::Metadata, _>| {
+            if let Ok(meta) = meta {
+                // Note: This can over-count bytes removed for hard-linked
+                // files. It also under-counts since it only counts the exact
+                // byte sizes and not the block sizes.
+                self.total_bytes_removed += meta.len();
+            }
             if !self.dry_run {
                 paths::remove_file(path)?;
             }
             Ok(())
         };
 
         if !meta.is_dir() {
-            return rm_file(path);
+            self.num_files_folders_cleaned += 1;
+            return rm_file(path, Ok(meta));
         }
 
         for entry in walkdir::WalkDir::new(path).contents_first(true) {
             let entry = entry?;
             self.progress.on_clean()?;
+            self.num_files_folders_cleaned += 1;
             if self.dry_run {
                 self.config
                     .shell()
@@ -368,13 +381,35 @@ impl<'cfg> CleanContext<'cfg> {
                     paths::remove_dir_all(entry.path())?;
                 }
             } else {
-                rm_file(entry.path())?;
+                rm_file(entry.path(), entry.metadata())?;
             }
         }
 
         Ok(())
     }
 
+    fn display_summary(&self) -> CargoResult<()> {
+        let status = if self.dry_run { "Summary" } else { "Removed" };
+        let byte_count = if self.total_bytes_removed == 0 {
+            String::new()
+        } else {
+            // Don't show a fractional number of bytes.
+            if self.total_bytes_removed < 1024 {
+                format!(", {}B total", self.total_bytes_removed)
+            } else {
+                let (bytes, unit) = human_readable_bytes(self.total_bytes_removed);
+                format!(", {bytes:.1}{unit} total")
+            }
+        };
+        self.config.shell().status(
+            status,
+            format!(
+                "{} files/directories{byte_count}",
+                self.num_files_folders_cleaned
+            ),
+        )
+    }
+
     /// Deletes all of the given paths, showing a progress bar as it proceeds.
     ///
     /// If any path does not exist, or is not accessible, this will not

tests/testsuite/clean.rs

@@ -272,7 +272,7 @@ fn clean_doc() {
 
     assert!(doc_path.is_dir());
 
-    p.cargo("clean --doc").run();
+    p.cargo("clean --doc").with_stderr("[REMOVED] [..]").run();
 
     assert!(!doc_path.is_dir());
     assert!(p.build_dir().is_dir());
@@ -414,9 +414,10 @@ fn clean_verbose() {
     if cfg!(target_os = "macos") {
         // Rust 1.69 has changed so that split-debuginfo=unpacked includes unpacked for rlibs.
         for obj in p.glob("target/debug/deps/bar-*.o") {
-            expected.push_str(&format!("[REMOVING] [..]{}", obj.unwrap().display()));
+            expected.push_str(&format!("[REMOVING] [..]{}\n", obj.unwrap().display()));
         }
     }
+    expected.push_str("[REMOVED] [..] files/directories, [..] total\n");
     p.cargo("clean -p bar --verbose")
         .with_stderr_unordered(&expected)
         .run();
@@ -607,7 +608,8 @@ error: package ID specification `baz` did not match any packages
     p.cargo("clean -p bar:1.0.0")
         .with_stderr(
             "warning: version qualifier in `-p bar:1.0.0` is ignored, \
-            cleaning all versions of `bar` found",
+            cleaning all versions of `bar` found\n\
+            [REMOVED] [..] files/directories, [..] total",
         )
         .run();
     let mut walker = walkdir::WalkDir::new(p.build_dir())
@@ -703,10 +705,16 @@ fn clean_dry_run() {
     };
 
     // Start with no files.
-    p.cargo("clean --dry-run").with_stdout("").run();
+    p.cargo("clean --dry-run")
+        .with_stdout("")
+        .with_stderr("[SUMMARY] 0 files/directories")
+        .run();
     p.cargo("check").run();
     let before = ls_r();
-    p.cargo("clean --dry-run").with_stdout("[CWD]/target").run();
+    p.cargo("clean --dry-run")
+        .with_stdout("[CWD]/target")
+        .with_stderr("[SUMMARY] [..] files/directories, [..] total")
+        .run();
     // Verify it didn't delete anything.
     let after = ls_r();
     assert_eq!(before, after);
@@ -715,6 +723,7 @@ fn clean_dry_run() {
     // Verify the verbose output.
     p.cargo("clean --dry-run -v")
         .with_stdout_unordered(expected)
+        .with_stderr("[SUMMARY] [..] files/directories, [..] total")
         .run();
 }
 

tests/testsuite/profile_custom.rs

@@ -543,7 +543,9 @@ fn clean_custom_dirname() {
     assert!(!p.build_dir().join("release").is_dir());
 
     // This should clean 'other'
-    p.cargo("clean --profile=other").with_stderr("").run();
+    p.cargo("clean --profile=other")
+        .with_stderr("[REMOVED] [..] files/directories, [..] total")
+        .run();
     assert!(p.build_dir().join("debug").is_dir());
     assert!(!p.build_dir().join("other").is_dir());
 }

tests/testsuite/script.rs

@@ -980,6 +980,7 @@ fn cmd_clean_with_embedded() {
         .with_stderr(
             "\
 [WARNING] `package.edition` is unspecified, defaulting to `2021`
+[REMOVED] [..] files/directories, [..] total
 ",
         )
         .run();