Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bnjbvr/cargo-machete
Remove unused Rust dependencies with this one weird trick!
https://github.com/bnjbvr/cargo-machete
cargo cargo-subcommand rust rust-lang
Last synced: 4 days ago
JSON representation
Remove unused Rust dependencies with this one weird trick!
- Host: GitHub
- URL: https://github.com/bnjbvr/cargo-machete
- Owner: bnjbvr
- License: mit
- Created: 2021-10-24T19:33:47.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-28T09:04:58.000Z (10 months ago)
- Last Synced: 2024-04-14T13:38:02.179Z (10 months ago)
- Topics: cargo, cargo-subcommand, rust, rust-lang
- Language: Rust
- Homepage:
- Size: 158 KB
- Stars: 541
- Watchers: 3
- Forks: 23
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ccamel - bnjbvr/cargo-machete - Remove unused Rust dependencies with this one weird trick! (Rust)
README
cargo-machete
Remove unused Rust dependencies with this one weird trick!
*Thanks to [Diego F. Goberna](https://github.com/feiss) for the lovely logo 🥰*
## Introduction
`cargo-machete` is a Cargo tool that detects unused dependencies in Rust
projects, in a fast (yet imprecise) way.
See also the [blog post](https://blog.benj.me/2022/04/27/cargo-machete/) for a
detailed writeup.
## Installation
Install `cargo-machete` with cargo:
`cargo install cargo-machete`
## Usage
Run cargo-machete in a directory that contains one or more Rust projects (using Cargo for
dependency management):
```bash
cd my-directory && cargo machete
# alternatively
cargo machete /absolute/path/to/my/directory
```
The **return code** gives an indication whether unused dependencies have been found:
- 0 if machete found no unused dependencies,
- 1 if it found at least one unused dependency,
- 2 if there was an error during processing (in which case there's no indication whether any unused
dependency was found or not).
This can be used in CI situations.
### False positives
To ignore a certain set of dependencies in a crate, add
`package.metadata.cargo-machete` to `Cargo.toml` (or `workspace.metadata.cargo-machete` to a
workspace `Cargo.toml`), and specify an `ignored` array:
For example:
```toml
[dependencies]
prost = "0.10" # Used in code generated by build.rs output, which cargo-machete cannot check
# in an individual package Cargo.toml
[package.metadata.cargo-machete]
ignored = ["prost"]
# in a workspace Cargo.toml
[workspace.metadata.cargo-machete]
ignored = ["prost"]
```
If there are too many false positives, consider using the `--with-metadata` CLI
flag, which will call `cargo metadata --all-features` to find final dependency
names, more accurate dependencies per build type, etc. âš This may modify the
`Cargo.lock` files in your projects.
## Docker Image
A docker image for cargo machete.
For instance, run `cargo-machete` in the `$(pwd)` directory using:
```
docker run -v $(pwd):/src ghcr.io/bnjbvr/cargo-machete:latest
```
## Cargo Machete Action
A github action for cargo machete.
### Example usage
The step given by,
```
- uses: bnjbvr/cargo-machete@main
```
can be added to any workflow.
An example workflow is shown below:
```yaml
name: Cargo Machete
on:
pull_request: { branches: "*" }
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Machete
uses: bnjbvr/cargo-machete@main
```
## Contributing
[](https://www.contributor-covenant.org/version/1/4/code-of-conduct/)
We welcome community contributions to this project.
## License
[MIT license](LICENSE.md).