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.

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

Settle on long term name #47

Open
Tracked by #61
epage opened this issue Aug 9, 2022 · 7 comments
Open
Tracked by #61

Settle on long term name #47

epage opened this issue Aug 9, 2022 · 7 comments
Labels
A-cli Area: engine around the lints C-enhancement Category: raise the bar on expectations M-breaking-change Meta: Implementing or merging this will introduce a breaking change.

Comments

@epage
Copy link
Collaborator

epage commented Aug 9, 2022

I'm thinking "if this were merged into cargo, what name should it have?"

Quick thoughts on criteria

  • Brief
  • Informative, including the idea of non-semver checks

Ideas

  • cargo api (currently taken)
  • cargo crate-api (I have this one)
  • cargo diff (available)
  • cargo preflight (reserved by @obi1kenobi)
@epage epage changed the title Settle on long term Settle on long term name Aug 9, 2022
@epage epage added A-cli Area: engine around the lints C-enhancement Category: raise the bar on expectations M-breaking-change Meta: Implementing or merging this will introduce a breaking change. labels Aug 9, 2022
@obi1kenobi
Copy link
Owner

I have cargo query, which might be another more general option. If we end up namespacing checks (and allowing user-specified checks and/or namespaces), that could for example be cargo query <namespace(s)> as in cargo query semver. Or perhaps cargo query <cmd> <namespace(s)> if we want additional modes, like diff vs check vs suggest version etc.

@epage
Copy link
Collaborator Author

epage commented Aug 9, 2022

I feel like query would be misleading. I would assume from the name that it is for searching crates at the current moment while cargo semver-checks is for linting the evolution of a crate's API

@obi1kenobi
Copy link
Owner

I see your point. Naming is hard :) Maybe as we make progress, some of the folks that worked on the original API evolution RFC might be interested in this and might have some naming ideas as well.

@jhpratt
Copy link

jhpratt commented Aug 17, 2022

I just reserved the cargo-diff crate. This is to prevent someone stealing the name and refusing to transfer it now that it's been mentioned here as a possibility. Happy to transfer it at any point if desired.

@obi1kenobi
Copy link
Owner

Added cargo-preflight (like a pre-flight checklist) to the idea list and reserved the name. Idea came up in #86.

@epage
Copy link
Collaborator Author

epage commented Aug 18, 2022

I feel like the name preflight has too narrow of a scope. For example cargo preflight --package clap --baseline-version 2.33 for reporting to me what changed in a dependency doesn't quite make sense but we have it as one of the possible use cases in #86

@tshepang
Copy link

tshepang commented Sep 7, 2023

am happy with semver-checks, otherwise semver works too

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-cli Area: engine around the lints C-enhancement Category: raise the bar on expectations M-breaking-change Meta: Implementing or merging this will introduce a breaking change.
Projects
None yet
Development

No branches or pull requests

4 participants