CLI: Put some common params in a central place #1484
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bfops
changed the title
jdetter
reviewed
Jul 8, 2024
| Arg::new("server") | ||
| .long("server") | ||
| .short('s') | ||
| .help("The nickname, host name or URL of the server") |
There was a problem hiding this comment.
if you do .help multiple times, does that latter one take precedence? For example, below you're doing something like server().help("custom help section for this command"). Does this work?
There was a problem hiding this comment.
confirmed this works as desired (see Testing section)
There was a problem hiding this comment.
Thanks, ideally it would just work and save us all a lot of suffering 😅
jdetter
reviewed
Jul 8, 2024
bfops
commented
Jul 8, 2024
| @@ -0,0 +1,15 @@ | |||
| use clap::Arg; | |||
There was a problem hiding this comment.
nit @jdetter does this belong more in src/ or src/subcommands?
There was a problem hiding this comment.
This is fine, leave it as is 👍
jdetter
approved these changes
Jul 9, 2024
| @@ -0,0 +1,15 @@ | |||
| use clap::Arg; | |||
There was a problem hiding this comment.
This is fine, leave it as is 👍
| @@ -27,16 +28,9 @@ pub fn cli() -> clap::Command { | |||
| .help("The name of the reducer to call"), | |||
| ) | |||
| .arg(Arg::new("arguments").help("arguments formatted as JSON").num_args(1..)) | |||
| .arg(common_args::server().help("The nickname, host name or URL of the server hosting the database")) | |||
There was a problem hiding this comment.
the overrides appear to be working
boppy@boppy-macbook SpacetimeDB % spacetime call --help
Invokes a reducer function in a database
Usage: spacetime call [OPTIONS] <database> <reducer_name> [arguments]...
Arguments:
<database> The database domain or address to use to invoke the call
<reducer_name> The name of the reducer to call
[arguments]... arguments formatted as JSON
Options:
-s, --server <server> The nickname, host name or URL of the server hosting the database
-i, --identity <identity> The identity to use for the call
-a, --anon-identity If this flag is present, the call will be executed with no identity provided
-h, --help Print help
Run `spacetime help call` for more detailed information.
lcodes
pushed a commit
that referenced
this pull request
Jul 9, 2024
Co-authored-by: Zeke Foppa <github.com/bfops>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of Changes
Created a
crates/cli/src/common_args.rsfile that currently just contains the most common form of the--server/-sparam and the--identity/-iparam.API and ABI breaking changes
None
Expected complexity level and risk
1
Testing