Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a *.metadata.cargo-machete.renamed field to configure renamed crates #152

Open
jalil-salame opened this issue Jan 28, 2025 · 3 comments · May be fixed by #153
Open

Add a *.metadata.cargo-machete.renamed field to configure renamed crates #152

jalil-salame opened this issue Jan 28, 2025 · 3 comments · May be fixed by #153

Comments

@jalil-salame
Copy link

Having an explicit renamed field should help with false positives without using --with-metadata, in my employer's codebase we see more false positives with --with-metadata.

I would be willing to code this feature.

Example:

[package.metadata.cargo-machete.renamed]
# crate-name = "import-name"
rustls-webpki = "webpki"
@bnjbvr
Copy link
Owner

bnjbvr commented Feb 13, 2025

Thanks for proposing this. I think it's a good idea, and if you're happy to implement and document it, that would be awesome!

@jalil-salame

This comment has been minimized.

Sign in to view
jalil-salame added a commit to jalil-salame/cargo-machete that referenced this issue Feb 13, 2025
@jalil-salame
feat(bnjbvr#152): add renamed configuration field
1331883 
This adds a `renamed` field that allows to map a dependency name to a
crate name without using `cargo metadata`.

For example:

```toml
[dependencies]
rustls-webpki = "0.102.8"

[package.metadata.cargo-machete.renamed]
rustls-webpki = "webpki"
```

This allows cargo machete to correctly mark `rustls-webpki` as used if a
`use webpki` or `webpki::UsedItem` is found in the codebase.
@jalil-salame jalil-salame linked a pull request Feb 13, 2025 that will close this issue
Open
3 tasks
@jalil-salame

This comment has been minimized.

Sign in to view
jalil-salame added a commit to jalil-salame/cargo-machete that referenced this issue Feb 15, 2025
@jalil-salame
feat(bnjbvr#152): add renamed configuration field
cc386a8 
This adds a `renamed` field that allows to map a dependency name to a
crate name without using `cargo metadata`.

For example:

```toml
[dependencies]
rustls-webpki = "0.102.8"

[package.metadata.cargo-machete.renamed]
rustls-webpki = "webpki"
```

This allows cargo machete to correctly mark `rustls-webpki` as used if a
`use webpki` or `webpki::UsedItem` is found in the codebase.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(#152): add renamed configuration field jalil-salame/cargo-machete
2 participants
@bnjbvr @jalil-salame