deepclean 0.1.2

A fast, parallel tool to clean Rust projects and remove unused dependencies
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
mod cleaner;
mod config;
mod deps;
mod output;
mod project;
mod utils;

use anyhow::{Context, Result};
use clap::Parser;
use colored::control;
use colored::Colorize;
use cleaner::{clean_project, CleanResult};
use config::{load_config, resolve_settings};
use deps::clean_dependencies;
use output::{create_progress_bars, create_project_progress_bar, print_error, print_summary, print_verbose_cleaned, Summary};
use project::find_cargo_projects;
use rayon::prelude::*;
use std::io::{self, BufRead, Write};
use utils::{get_directory_size, parse_size};

#[derive(Parser, Debug)]
#[command(name = "cargo-deepclean")]
#[command(about = "Recursively clean Cargo projects with workspace support", long_about = None)]
#[command(bin_name = "cargo deepclean")]
struct Args {
    /// Directory to start cleaning from
    #[arg(default_value = ".")]
    directory: std::path::PathBuf,

    /// Dry run mode (don't actually clean, just show what would be cleaned)
    #[arg(long)]
    dry_run: bool,

    /// Exclude patterns (glob patterns, can be specified multiple times)
    #[arg(short = 'e', long = "exclude")]
    exclude_patterns: Vec<String>,

    /// Number of parallel jobs
    #[arg(short = 'j', long = "jobs")]
    jobs: Option<usize>,

    /// Verbose output
    #[arg(short, long)]
    verbose: bool,

    /// JSON output
    #[arg(long)]
    json: bool,

    /// Minimum size threshold (e.g., "100MB", "1GB") - only clean projects above this size
    #[arg(long)]
    min_size: Option<String>,

    /// Check for unused dependencies (native detection)
    #[arg(long)]
    clean_deps: bool,

    /// Remove unused dependencies (automatically enables --clean-deps, requires cargo-remove)
    #[arg(long)]
    remove_deps: bool,

    /// Prompt for confirmation before cleaning
    #[arg(long)]
    interactive: bool,
}

fn parse_args() -> Args {
    let mut args_iter = std::env::args();
    let program_name = args_iter.next();

    let first_arg = args_iter.next();
    if first_arg.as_deref() == Some("deepclean") {
        Args::parse_from(args_iter)
    } else {
        let mut all_args = vec![program_name.unwrap_or_else(|| "cargo-deepclean".to_string())];
        if let Some(arg) = first_arg {
            all_args.push(arg);
        }
        all_args.extend(args_iter);
        Args::parse_from(all_args)
    }
}

fn confirm_interactive(projects: &[project::Project], dry_run: bool) -> Result<bool> {
    println!();
    println!(
        "{} Found {} project(s) to clean:",
        "[INFO]".blue().bold(),
        projects.len()
    );
    for project in projects {
        let target_dir = project.path.join("target");
        let size = if target_dir.exists() {
            get_directory_size(&target_dir).unwrap_or(0)
        } else {
            0
        };
        println!(
            "  • {} ({})",
            project.path.display(),
            utils::format_bytes(size)
        );
    }

    if dry_run {
        println!(
            "{} Dry run mode: no changes will be made if you continue.",
            "[INFO]".yellow().bold()
        );
    }

    print!(
        "{} Proceed with cleaning? [y/N]: ",
        "[PROMPT]".cyan().bold()
    );
    io::stdout().flush()?;

    let mut line = String::new();
    io::stdin().lock().read_line(&mut line)?;
    Ok(matches!(line.trim().to_ascii_lowercase().as_str(), "y" | "yes"))
}

fn main() -> Result<()> {
    let args = parse_args();

    let config = load_config(&args.directory)
        .context("Failed to load configuration. Check .deepclean.toml syntax and permissions.")?;

    let settings = resolve_settings(
        config.as_ref(),
        &args.exclude_patterns,
        args.jobs,
        args.min_size.as_deref(),
        args.json,
    );

    control::set_override(settings.use_color);

    let root = args
        .directory
        .canonicalize()
        .with_context(|| {
            format!(
                "Failed to resolve directory {:?}. \
Ensure the path exists and you have permission to read it.",
                args.directory
            )
        })?;

    if !settings.json {
        println!(
            "{} Starting cargo clean from: {:?}",
            "[INFO]".blue().bold(),
            root
        );
        println!(
            "{} Searching for Cargo projects...",
            "[INFO]".blue().bold()
        );
    }

    rayon::ThreadPoolBuilder::new()
        .num_threads(settings.jobs)
        .build_global()
        .context("Failed to configure parallel job count")?;

    let projects = find_cargo_projects(&root, &settings.exclude_patterns)
        .context("Failed to find Cargo projects while scanning the directory tree")?;

    if projects.is_empty() {
        if !settings.json {
            println!(
                "{} No Cargo projects found",
                "[WARNING]".yellow().bold()
            );
        }
        return Ok(());
    }

    let min_size_bytes = if let Some(ref min_size_str) = settings.min_size {
        Some(parse_size(min_size_str).with_context(|| {
            format!(
                "Invalid min-size value '{}'. Expected a size like '100MB', '1GB', or '500KB'.",
                min_size_str
            )
        })?)
    } else {
        None
    };

    let projects: Vec<_> = if let Some(min_bytes) = min_size_bytes {
        projects
            .par_iter()
            .filter(|project| {
                let target_dir = project.path.join("target");
                if target_dir.exists() {
                    get_directory_size(&target_dir).unwrap_or(0) >= min_bytes
                } else {
                    false
                }
            })
            .cloned()
            .collect()
    } else {
        projects
    };

    if projects.is_empty() {
        if !settings.json {
            if min_size_bytes.is_some() {
                println!(
                    "{} No projects found above the minimum size threshold",
                    "[INFO]".blue().bold()
                );
            } else {
                println!(
                    "{} No Cargo projects found",
                    "[WARNING]".yellow().bold()
                );
            }
        }
        return Ok(());
    }

    if args.interactive && !confirm_interactive(&projects, args.dry_run)? {
        if !settings.json {
            println!("{} Cancelled by user", "[INFO]".blue().bold());
        }
        return Ok(());
    }

    if !settings.json {
        println!(
            "{} Found {} project(s)",
            "[INFO]".blue().bold(),
            projects.len()
        );
        if args.dry_run {
            println!(
                "{} DRY RUN MODE - no changes will be made",
                "[INFO]".yellow().bold()
            );
        }
        let clean_deps = args.clean_deps || args.remove_deps;
        if clean_deps {
            println!(
                "{} Dependency cleaning enabled (native detection)",
                "[INFO]".blue().bold()
            );
            if args.remove_deps {
                println!(
                    "{} Will remove unused dependencies (requires cargo-remove)",
                    "[INFO]".yellow().bold()
                );
            }
        }
        println!();
    }

    let (multi, overall_pb) =
        create_progress_bars(projects.len(), !settings.json && !args.verbose);

    let results: Vec<CleanResult> = projects
        .par_iter()
        .with_min_len(1)
        .map(|project| {
            let project_pb = multi
                .as_ref()
                .map(|multi| create_project_progress_bar(multi, &project.path));

            if args.verbose && !settings.json {
                println!(
                    "{} Cleaning: {:?}",
                    "[INFO]".blue().bold(),
                    project.path
                );
            }

            let result = clean_project(project, args.dry_run, args.verbose);

            if args.clean_deps || args.remove_deps {
                let deps_result =
                    clean_dependencies(project, args.dry_run, args.remove_deps, args.verbose);
                match deps_result {
                    Ok(deps_clean) => {
                        if !deps_clean.unused_deps.is_empty() {
                            if !settings.json {
                                println!(
                                    "{} Found {} unused dependency(ies) in {}:",
                                    "[INFO]".blue().bold(),
                                    deps_clean.unused_deps.len(),
                                    project.path.display()
                                );
                                for dep in &deps_clean.unused_deps {
                                    println!(
                                        "  {} {} ({})",
                                        "•".yellow(),
                                        dep.name.bright_yellow(),
                                        dep.location
                                    );
                                }
                                if deps_clean.removed_count > 0 {
                                    println!(
                                        "{} Removed {} unused dependency(ies)",
                                        "[SUCCESS]".green().bold(),
                                        deps_clean.removed_count
                                    );
                                } else if args.remove_deps && !args.dry_run {
                                    if let Some(ref error) = deps_clean.error {
                                        println!(
                                            "{} Failed to remove dependencies: {}. \
Install cargo-edit with `cargo install cargo-edit`.",
                                            "[ERROR]".red().bold(),
                                            error
                                        );
                                    } else {
                                        println!(
                                            "{} Could not remove dependencies. \
Install cargo-remove with `cargo install cargo-edit`.",
                                            "[WARNING]".yellow().bold()
                                        );
                                    }
                                } else if args.dry_run {
                                    println!(
                                        "{} Would remove {} dependency(ies) (use --remove-deps to actually remove)",
                                        "[INFO]".blue().bold(),
                                        deps_clean.unused_deps.len()
                                    );
                                }
                            }
                        } else if !settings.json && args.verbose {
                            println!(
                                "{} No unused dependencies found in {}",
                                "[INFO]".blue().bold(),
                                project.path.display()
                            );
                        }

                        if let Some(ref error) = deps_clean.error {
                            if !settings.json {
                                println!(
                                    "{} Error during dependency removal in {:?}: {}",
                                    "[ERROR]".red().bold(),
                                    project.path,
                                    error
                                );
                            }
                        }
                    }
                    Err(e) => {
                        if !settings.json {
                            println!(
                                "{} Failed to check dependencies in {:?}: {}",
                                "[WARNING]".yellow().bold(),
                                project.path,
                                e
                            );
                        }
                    }
                }
            }

            if let Some(ref pb) = project_pb {
                let project_name = project
                    .path
                    .file_name()
                    .and_then(|n| n.to_str())
                    .map(|s| s.to_string())
                    .unwrap_or_else(|| project.path.to_string_lossy().to_string());
                pb.finish_with_message(format!("✓ {}", project_name));
            }

            if let Some(ref overall) = overall_pb {
                overall.inc(1);
            }

            match result {
                Ok(r) => {
                    if args.verbose && !settings.json {
                        print_verbose_cleaned(&r);
                    }
                    Ok(r)
                }
                Err(e) => {
                    let error_msg = e.to_string();
                    if !settings.json {
                        print_error(&project.path, &error_msg);
                    }
                    Ok(CleanResult {
                        path: project.path.to_string_lossy().to_string(),
                        success: false,
                        freed_bytes: 0,
                        error: Some(error_msg),
                    })
                }
            }
        })
        .collect::<Result<Vec<_>>>()?;

    if let Some(ref overall) = overall_pb {
        overall.finish_with_message("All projects completed!");
    }

    let cleaned = results.iter().filter(|r| r.success).count();
    let failed = results.len() - cleaned;
    let total_freed: u64 = results.iter().map(|r| r.freed_bytes).sum();

    let summary = Summary {
        total_projects: projects.len(),
        cleaned,
        failed,
        total_freed_bytes: total_freed,
        results,
    };

    if settings.json {
        println!("{}", serde_json::to_string_pretty(&summary)?);
    } else {
        print_summary(&summary);
    }

    if failed > 0 {
        std::process::exit(1);
    }

    Ok(())
}