🧹 rs_clean – Clean Build Targets for Rust, Go, Gradle, and Maven

⚡ Easily remove compiled build artifacts from Rust, Go, Gradle, and Maven projects with a single command.

📘 Looking for Chinese docs? View 中文说明 🇨🇳

🏗️ Architecture Overview

graph TD
    A[rs_clean CLI] --> B{main.rs};
    B --> C(Command Line Argument Parsing: clap);
    C --> D(Initialize Cleaning Commands: constant.rs, utils.rs);
    D -- Supported Commands --> E[lib.rs - do_clean_all];
    E -- Recursive Scan --> F(walkdir);
    F -- Project Identification & Task Generation --> G{cmd.rs - Cmd};
    G -- Asynchronous Execution & Concurrency Control --> H(tokio, Semaphore, futures::join_all);
    H -- Actual Cleaning Operation --> I(Cmd::run_clean);
    I -- External Command Execution --> J(tokio::process::Command);
    I -- node_modules Deletion --> K(tokio::fs::remove_dir_all);
    E -- Result Statistics & Formatting --> L(get_dir_size_async, format_size);
    L -- Progress Display & Final Report --> M(indicatif, colored);

🚀 Quick Start

$ rs_clean folder/

This command recursively removes build directories in the specified folder and its subdirectories.

You can also exclude specific directory names from cleaning:

$ rs_clean folder/ --exclude-dir node_modules --exclude-dir build

Or exclude certain project types:

$ rs_clean folder/ --exclude-type go --exclude-type maven

📦 Installation

Option 1: Install via Cargo

cargo install rs_clean

Option 2: Download from Releases

👉 Download from GitHub Releases Grab the latest binary for your operating system.

✨ Features

✅ Cleans Rust projects: target/
✅ Cleans Go build output
✅ Cleans Gradle projects: build/
✅ Cleans Maven projects: target/
✅ Cleans Node.js projects: node_modules/ (by removing node_modules directory directly)
✅ Cleans Python projects: __pycache__/, venv/, .venv/, build/, dist/, .eggs/, etc. (by removing these directories directly)
✅ Recursively scans subdirectories
✅ Automatically detects project type
✅ Efficient Parallel Processing: Utilizes asynchronous operations and CPU core awareness for fast, concurrent cleaning.
✅ Safety Mechanisms: Includes limits on directory depth and file count to prevent excessive resource consumption.
✅ Disk Space Reporting: Shows the total disk space freed after cleanup.

📂 Example Structure

$ tree my_projects/

my_projects/

├── rust_app/

│   └── target/

├── go_service/

│   └── bin/

├── gradle_app/

│   └── build/

└── maven_module/

    └── target/

After running:

$ rs_clean my_projects/

The build artifacts will be cleaned:

$ tree my_projects/

my_projects/

├── rust_app/

├── go_service/

├── gradle_app/

└── maven_module/

💡 Use Cases

Free up disk space by removing large build folders.
Ensure a clean build environment in CI/CD pipelines.
Clean multiple types of projects in monorepos.

🛠 Roadmap

Add interactive confirmation prompts
More detailed disk space reporting per project
Customizable exclusion lists for specific directories/files (partially implemented with --exclude-dir)

🤝 Contributing

We welcome contributions and feedback!

Open an issue for bugs or suggestions
Submit a pull request for enhancements
Star ⭐ the repo if you find it helpful

rs_clean 0.3.0