Detect and fix issues in Rust projects:
- Unused dependencies in
Cargo.toml - Misplaced dependencies (dev/build dependencies in wrong sections)
- Unlinked source files (Rust files not reachable from any module tree)
# Install from pre-built binaries.
cargo binstall cargo-shear
# Build from source.
cargo install cargo-shear
# Install from brew.
brew install cargo-shearCheck for issues without making changes:
cargo shearAutomatically fix unused dependencies:
cargo shear --fixGenerate machine-readable JSON output:
cargo shear --format=jsonThis is particularly useful for CI/CD pipelines and custom tooling that need to programmatically process the results.
Important
cargo shear cannot detect "hidden" imports from macro expansions without the --expand flag (nightly only).
This is because cargo shear uses rust-analyzer's parser to parse files and does not expand macros by default.
To expand macros:
cargo shear --expand --fixThe --expand flag uses cargo expand, which requires nightly and is significantly slower.
Important
Misplaced dependency detection only works for integration tests, benchmarks, and examples.
Unit tests dependencies within #[cfg(test)] cannot be detected as misplaced.
False positives can be ignored by adding them to the package's Cargo.toml:
[package.metadata.cargo-shear]
ignored = ["crate-name"]Unlinked files can be ignored using glob patterns:
[package.metadata.cargo-shear]
ignored-paths = ["src/proto/*.rs", "examples/old/*"]Both options work in workspace Cargo.toml as well:
[workspace.metadata.cargo-shear]
ignored = ["crate-name"]
ignored-paths = ["*/proto/*.rs"]Otherwise please report the issue as a bug.
- name: Install cargo-binstall
uses: cargo-bins/cargo-binstall@main
- name: Install cargo-shear
run: cargo binstall --no-confirm cargo-shear
- run: cargo shearFor CI systems that require structured output, use the --format=json flag:
- name: Check for unused dependencies
run: cargo shear --format=json > shear-results.jsonThe JSON output includes:
- summary: Counts of errors, warnings, and fixes
- findings: Detailed information about each issue including:
code: The diagnostic code (e.g.,shear/unused_dependency)severity: Error or warning levelmessage: Human-readable descriptionfile: Path to the file with the issuelocation: Byte offset and length within the filehelp: Suggested fixfixable: Boolean indicating if issue can be auto-fixed with--fix
| Exit Code | Without --fix |
With --fix |
|---|---|---|
| 0 | No issues found | No issues found, no changes made |
| 1 | Issues found | Issues found and fixed |
| 2 | Error during processing | Error during processing |
GitHub Actions Example:
- name: cargo-shear
shell: bash
run: |
if ! cargo shear --fix; then
cargo check
fi- Use the
cargo_metadatacrate to list all dependencies specified in[workspace.dependencies]and[dependencies] - Iterate through all package targets (
lib,bin,example,testandbench) to locate all Rust files - Use rust-analyzer's parser (
ra_ap_syntax) to parse these Rust files and extract imports- Alternatively, use the
--expandoption withcargo expandto first expand macros and then parse the expanded code (though this is significantly slower)
- Alternatively, use the
- Find the difference between the imports and the package dependencies
- est31/cargo-udeps
- it collects dependency usage by compiling your project and find them from the
target/directory - does not seem to work anymore with the latest versions of
cargo - does not work with cargo workspaces
- it collects dependency usage by compiling your project and find them from the
- bnjbvr/cargo-machete
- it collects dependency usage by running regex patterns on source code
- does not detect all usages of a dependency
- does not remove unused dependencies from the workspace root
- cargo and clippy
- There was intention to add similar features to cargo or clippy, but the progress is currently stagnant
- See rust-lang/rust#57274 and rust-lang/rust-clippy#4341