Migrate to Clap v4 #298
Migrate to Clap v4 #298
Conversation
|
I think everything should work fine now, but the PR is currently blocked on #352. |
| -p, --platform <PLATFORMS> Override the operating system [possible values: linux, macos, windows, | ||
| sunos, android] |
There was a problem hiding this comment.
The help now doesn't list aliases anymore. I changed the code to use "macos" as main name and "osx" as alias (not vice versa), so that "macos" is shown in the help by default. "osx" still works though.
There was a problem hiding this comment.
For it to show aliases, you now have to use visible_alias, if I recall correctly. You can have a mix of visible and invisible aliases.
| Danilo Bargen <[email protected]>, Niklas Mohrin <[email protected]> | ||
| A fast TLDR client |
There was a problem hiding this comment.
The default help output in clap now doesn't list version and author anymore.
I updated the help template to include those two again. The version is now combined with the description to get more compact output.
| "Unknown color option: {}. Possible values: always, auto, never", | ||
| other | ||
| )), | ||
| impl clap::ValueEnum for ColorOptions { |
There was a problem hiding this comment.
Shouldn't we be able to use the derive macro here? https://docs.rs/clap/latest/clap/_derive/_tutorial/chapter_3/index.html#enumerated-values (also for the other one above?)
| long = "color", | ||
| value_name = "WHEN", | ||
| possible_values = ["always", "auto", "never"] | ||
| value_parser = EnumValueParser::<ColorOptions>::new(), |
There was a problem hiding this comment.
We don't need to be so verbose here, we can use #[arg(value_enum)] or even not specify anything and clap will figure this out on its own (same for the other value enum)
| value_parser = EnumValueParser::<ColorOptions>::new(), |
| )] | ||
| //possible_values = ["always", "auto", "never"] |
There was a problem hiding this comment.
| //possible_values = ["always", "auto", "never"] |
| after_help = "To view the user documentation, please visit https://dbrgn.github.io/tealdeer/." | ||
| #[command( | ||
| about = "A fast TLDR client", | ||
| version = "1.2.3", |
There was a problem hiding this comment.
Clap can read the version from Cargo.toml:
| version = "1.2.3", | |
| version, |
Again, this is a pretty big update with multiple breaking changes that requires changing how our argument parsing is set up. (If I ignore the effort to upgrade, this update does contain some nice API improvements, so I guess in the long term it's worth it. The blogpost is an interesting read.)
This is still WIP, I'm opening this PR to avoid duplicate work on this.