Some CLI improvements #54
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
beanpuppy
approved these changes
Feb 16, 2025
clorinde/src/cli.rs
Outdated
| cfg.sync = sync; | ||
| cfg.r#async = r#async || !sync; | ||
| cfg.serialize = serialize; | ||
| if let Some(podman) = podman { |
There was a problem hiding this comment.
suggestion: instead of if let Some(...) you could do cfg.podman = podman.unwrap_or(cfg.podman);. But async might need something like cfg.r#async = r#async.map_or(cfg.r#async, |a| a || !cfg.sync);
There was a problem hiding this comment.
done! thank you for the quick feedback!
| } | ||
|
|
||
| #[derive(Debug, Subcommand)] | ||
| enum Action { | ||
| /// Generate your modules against your own db | ||
| Live { | ||
| #[clap(env = "DATABASE_URL")] |
There was a problem hiding this comment.
Nice, didn't know about using env with clap. This will be useful in the future.
Merged
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.
The main problem I was facing with the CLI was that CLI default values were overwriting values from the config file. This happened because
cfgvariable was set by the config file, and the CLI values overwrote the values with default values.For example,
queriespath anddestinationpath were keeping being overwritten to default CLI values even though I specified otherwise in the config file. This confused me for a long time.I solved this by making all CLI args optional and only overwriting the config values if they exist.
Second annoyance that I had was that all the cli args were required before the subcommand; this went against the usual CLI experience where I would write
command subcommand --arg1 val1 --arg2 val2; instead, I have to docommand --arg1 val1 --arg2 val2 subcommand.Solution for this is just feeding the args to the subcommand. This has added benefit of
clorinde live -hshowing all args descriptions.Also, I made the database url be fetchable by env var
DATABASE_URLso I don't have to feed it to the cli everytime.