cargo-semver-checks icon indicating copy to clipboard operation
cargo-semver-checks copied to clipboard

Settle on long term name

Open epage opened this issue 2 years ago • 7 comments

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 avatar Aug 09 '22 14:08 epage

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.

obi1kenobi avatar Aug 09 '22 21:08 obi1kenobi

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

epage avatar Aug 09 '22 21:08 epage

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.

obi1kenobi avatar Aug 09 '22 21:08 obi1kenobi

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.

jhpratt avatar Aug 17 '22 06:08 jhpratt

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

obi1kenobi avatar Aug 18 '22 19:08 obi1kenobi

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

epage avatar Aug 18 '22 19:08 epage

am happy with semver-checks, otherwise semver works too

tshepang avatar Sep 07 '23 18:09 tshepang