Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mathieubes committed Nov 26, 2024
1 parent 83dd0e0 commit bd1e99d
Showing 1 changed file with 34 additions and 22 deletions.
56 changes: 34 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
# spedesunu
# desunu

**spedesunu** is a lightweight Rust-based CLI tool designed to help you identify unused dependencies in your project. Currently focused on Node.js projects, **spedesunu** scans your files to find and report unused dependencies, but in the future, it will support multiple project types (e.g., Python, Go, Ruby, etc.).
**desunu** is a blazing-fast, Rust-based CLI tool designed to help you locate unused dependencies in your projects. Whether you're working with `package.json` for Node.js, `Cargo.toml` for Rust, or eventually other project types, **desunu** scans your files, analyzes your dependencies, and provides actionable insights.

---
Our vision is simple: **desunu** should be the *first tool you think of* when you need to find unused things.

## Features

- Detect unused dependencies in Node.js projects.
- Supports common JavaScript/TypeScript file extensions (`.js`, `.jsx`, `.ts`, `.tsx`) and more.
- Automatically excludes irrelevant files and directories (e.g., `node_modules/`).
- Simple and intuitive output highlighting unused dependencies.
- Planned extensibility for additional project types (Python, Go, Ruby, etc.).
- **Comprehensive Dependency Scanning**: Detect every unused dependency in your project, starting with Node.js (`package.json`) and Rust (`Cargo.toml`).
- **Blazing Performance**: Analyze projects with 250+ packages and 2300+ files in less than 5 seconds.
- **File-Based Analysis**: Reads and scans your files directly without relying on external services like LSP.
- **Future-Ready**: Designed for extensibility, with plans to support additional ecosystems like Python, Go, and Ruby.

---
## Why Use desunu?

- Keep your projects clean and lean by identifying unnecessary dependencies.
- Avoid performance issues and vulnerabilities caused by unused libraries.
- Focus on simplicity and speed: no complex setups, just results.

## Installation

Expand All @@ -22,32 +25,37 @@
### Steps
1. Clone the repository:
```bash
git clone https://github.com/yourusername/spedesunu.git
git clone https://github.com/yourusername/desunu.git
```

2. Navigate to the project directory:
```bash
cd spedesunu
cd desunu
```

3. Build the project:
```bash
cargo build --release
cargo build --release
```

4. You can now run spedesunu with your Node.js project to detect unused dependencies.
4. Run the executable from the `target/release/` folder to start using desunu.

## Usage
### Scan Your Node.js Project

To scan your project directory and detect unused dependencies, simply run:
### Basic Usage

To scan your project directory and detect unused dependencies, run:

```bash
spedesunu
desunu all
```

This will scan the files in the current directory (and subdirectories), compare them with the dependencies in your `package.json`, and output which dependencies are unused.
desunu will:

1. Detect in which project type you are (Node, Rust, Ruby, etc...).
2. Analyze the files in your project directory (and subdirectories).
3. Cross-reference your dependency file (package.json, Cargo.toml) with the actual imports or usage in your code.
4. Output a clear list of unused dependencies.

## Contributing

Expand All @@ -61,14 +69,18 @@ We welcome contributions! If you'd like to improve spedesunu or add support for
## Roadmap
- Support for multiple project types (Python, Go, Ruby, etc.)
- Improved file scanning for more efficient dependency detection
- Customizable configuration for ignoring specific files, extensions, etc.
- Enhanced reporting to display dependencies in different formats (JSON, CSV, etc.)
- Add support for Python, Go, Ruby, and more project types.
- Customizable configurations for ignoring specific files or dependencies.
- Advanced reporting formats (JSON, CSV, etc.).
- Integration into CI/CD pipelines for automated checks.
## Performance
**desunu** is optimized for speed. It can scan large projects with thousands of files and hundreds of dependencies in just a few seconds, making it an ideal tool for both developers and CI environments.
## License
**spedesunu** is licensed under the MIT License.
**desunu** is licensed under the MIT License.
## Acknowledgments
Expand Down

0 comments on commit bd1e99d

Please sign in to comment.