This PR contains the following updates:
| Package | Type | Update | Change |
|---|---|---|---|
| clap | dependencies | major | 3.2 -> 4.0 |
Release Notes
clap-rs/clap
Compare Source
Features
- Have
Arg::value_parser accept Vec<impl Into<PossibleValue>>
- Implement
Display and FromStr for ColorChoice
Fixes
- Remove soundness issue by switching from
atty to is-terminal
Compare Source
Fixes
- (error) Fix typos in
ContextKind::as_str
Compare Source
Features
- (error) Report available subcommands when required subcommand is missing
Compare Source
Fixes
- Avoid panic when printing an argument that isn't built
Compare Source
Fixes
- Don't panic on reporting invalid-long errors when followed by invalid UTF8
- (help) Clarified argument to
help subcommand
Compare Source
Fixes
- (help) Don't overflow into next-line-help early due to stale (pre-v4) padding calculations
Compare Source
Features
- (derive)
long_about and long_help attributes, without a value, force using doc comment (before it wouldn't be set if there wasn't anything different than the short help)
Compare Source
Fixes
- (derive) Allow defaulted value parser for '()' fields
Compare Source
Features
ColorChoice now implements ValueEnum
Compare Source
Fixes
- (derive) Allow
#[command(skip)] to also work with enum variants with a value
Compare Source
Fixes
- Allow using
Arg::last(true) with Arg::value_hint(ValueHint::CommandWithArguments)
Compare Source
Fixes
Arg::exclusive(true) should not be exclusive with the argument's own ArgGroup
Compare Source
Fixes
- (error) Don't suggest
-- when it doesn't help
- (error) Be more consistent in quoting, punctuation, and indentation in errors
Compare Source
Fixes
- Only put
ArgGroup in ArgMatches whenย explicitly specified, fixing derives handling of option-flattened fields (#โ4375)
Compare Source
Features
- (derive) Allow
() for fields to mean "don't read" (#โ4371)
Compare Source
Features
- Added
TypedValueParser::try_map for when adapting an existing TypedValueParser can fail
- (error) Create errors like clap with
Error::new, Error::with_cmd, and Error::insert
Compare Source
Fixes
- (help) Fix wrapping calculations with ANSI escape codes
Compare Source
Features
Compare Source
Fixes
- (derive) Process doc comments for
#[command(subcommand)] like in clap v3
Compare Source
Fixes
- (derive) Remove a low-value assert preventing defaulting
Help and Version actions
Compare Source
Features
- (derive) Populate implicit ArgGroup (#โ3165)
Fixes
- (derive) Support
#[group(skip)] on Parser derive
- (derive) Tell users about implicit arg groups when running into group name conflicts
- (error) Don't report unrelated groups in conflict or requires errors
Compare Source
Features
Compare Source
Compare Source
Fixes
- (error) Specialize the self-conflict error to look like clap v3
Compare Source
Fixes
- (error) Quote literals consistently
- (error) Stylize escape (
--) suggestions
- (error) Format help flag as a literal
Compare Source
Features
- Have
Arg::value_parser accept Vec<impl Into<PossibleValue>>
- Implement
Display and FromStr for ColorChoice
Fixes
- Remove soundness issue by switching from
atty to is-terminal
Compare Source
Features
ColorChoice now implements ValueEnum
Compare Source
Highlights
Arg::num_args(range)
Clap has had several ways for controlling how many values will be captured without always being clear on how they interacted, including
Arg::multiple_values(true)Arg::number_of_values(4)Arg::min_values(2)Arg::max_values(20)Arg::takes_value(true)
These have now all been collapsed into Arg::num_args which accepts both
single values and ranges of values. num_args controls how many raw arguments
on the command line will be captured as values per occurrence and independent
of value delimiters.
See Issue 2688 for more background.
Polishing Help
Clap strives to give a polished CLI experience out of the box with little
ceremony. With some feedback that has accumulated over time, we took this
release as an opportunity to re-evaluate our --help output to make sure it is
meeting that goal.
In doing this evaluation, we wanted to keep in mind:
- Whether other CLIs had ideas that make sense to apply
- Providing an experience that fits within the rest of applications and works across all shells
Before:
git
A fictional versioning CLI
USAGE:
git <SUBCOMMAND>
OPTIONS:
-h, --help Print help information
SUBCOMMANDS:
add adds things
clone Clones repos
help Print this message or the help of the given subcommand(s)
push pushes things
stash
After:
A fictional versioning CLI
Usage: git <COMMAND>
Commands:
clone Clones repos
push pushes things
add adds things
stash
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help information
- name/version header was removed because we couldn't justify the space it occupied when
- Usage already includes the name
--version is available for showing the same thing (if the program has a version set)
- Usage was dropped to one line to save space
- Focus is put on the subcommands
- Headings are now Title case
- The more general term "command" is used rather than being explicit about being "subcommands"
- The output is more dense with the expectation that it won't affect legibility but will allow more content
- We've moved to a more neutral palette for highlighting elements (not highlighted above)
In talking to users, we found some that liked clap's man-like experience.
When deviating from this, we are making the assumption that those are more
power users and that the majority of users wouldn't look as favorably on being
consistent with man.
See Issue 4132 for more background.
More Dynamicism
Clap's API has focused on &str for performance but this can make
dealing with owned data difficult, like #[arg(default_value_t)] generating a
String from the default value.
Additionally, to avoid ArgMatches from borrowing (and for some features we
decided to forgo), clap took the &str argument IDs and hashed them. This
prevented us from providing a usable API for iterating over existing arguments.
Now clap has switched to a string newtype that gives us the flexibility to
decide whether to use &'static str, Cow<'static, str> for fast dynamic behavior, or
Box<str> for dynamic behavior with small binary size.
As an extension of that work, you can now call ArgMatches::ids to iterate
over the arguments and groups that were found when parsing. The newtype Id
was used to prevent some classes of bugs and to make it easier to understand
when opaque Ids are used vs user-visible strings.
Clearing Out Deprecations
Instead of doing all development on clap 4.0.0, we implemented a lot of new features during clap 3's development, deprecating the old API while introducing the new API, including:
- Replacing the implicit behavior for args when parsing them with
ArgAction
- Replacing various one-off forms of value validation with the
ValueParser API
- Allowing derives to automatically do the right thing for
PathBuf (allowing invalid UTF-8)
- Replacing
AppSettings and ArgSettings enums with getters/setters
- Clarifying terms and making them more consistent
Migrating
Steps:
- Upgrade to v3 if you haven't already
- Add CLI tests (including example below),
-h and --help output at a minimum (recommendation: trycmd for snapshot testing)
- If using Builder API: Explicitly set the
arg.action(ArgAction::...) on each argument (StoreValue for options and IncOccurrences for flags)
- Run
cargo check --features clap/deprecated and resolve all deprecation warnings
- Upgrade to v4
- Update feature flags
- If
default-features = false, run cargo add clap -F help,usage,error-context
- Run
cargo add clap -F wrap_help unless you want to hard code line wraps
- Resolve compiler errors
- Resolve behavior changes (see "subtle changes" under BREAKING CHANGES)
- At your leisure: resolve new deprecation notices
Example test (derive):
#[derive(clap::Parser)]
struct Cli {
...
}
#[test]
fn verify_cli() {
use clap::CommandFactory;
Cli::command().debug_assert()
}
Example test (builder):
fn cli() -> clap::Command {
...
}
#[test]
fn verify_cli() {
cli().debug_assert();
}
Note: the idiomatic / recommended way of specifying different types of args in the Builder API has changed:
Before
.arg(Arg::new("flag").long("flag")) # --flag
.arg(Arg::new("option").long("option").takes_value(true)) # --option <option>
After:
.arg(Arg::new("flag").long("flag").action(ArgAction::SetTrue)) # --flag
.arg(Arg::new("option").long("option")) # --option <option>
In particular, num_args (the replacement for takes_value) will default appropriately
from the ArgAction and generally only needs to be set explicitly for the
other num_args use cases.
Breaking Changes
Subtle changes (i.e. compiler won't catch):
arg! now sets one of (#โ3795):
ArgAction::SetTrue, requiring ArgMatches::get_flag instead of ArgMatches::is_presentArgAction::Count, requiring ArgMatches::get_count instead of ArgMatches::occurrences_ofArgAction::Set, requiring ArgMatches::get_one instead of ArgMatches::value_ofArgAction::Append, requiring ArgMatches::get_many instead of ArgMatches::values_of
ArgAction::Set, ArgAction::SetTrue, and Arg::Action::SetFalse now
conflict by default to be like ArgAction::StoreValue and
ArgAction::IncOccurrences, requiring cmd.args_override_self(true) to override instead (#โ4261)- By default, an
Args default action is ArgAction::Set, rather than ArgAction::IncOccurrence to reduce confusing magic through consistency (#โ2687, #โ4032, see also #โ3977)
mut_arg can no longer be used to customize help and version arguments, instead disable them (Command::disable_help_flag, Command::disable_version_flag) and provide your own (#โ4056)- Removed lifetimes from
Command, Arg, ArgGroup, and PossibleValue, assuming 'static. string feature flag will enable support for Strings (#โ1041, #โ2150, #โ4223)
arg!(--flag <value>) is now optional, instead of required. Add .required(true) at the end to restore the original behavior (#โ4206)- Added default feature flags,
help, usage and error-context, requiring adding them back in if default-features = false (#โ4236)
- (parser) Always fill in
"" argument for external subcommands to make it easier to distinguish them from built-in commands (#โ3263)
- (parser) Short flags now have higher precedence than hyphen values with
Arg::allow_hyphen_values, to be consistent with Command::allow_hyphen_values (#โ4187)
- (parser)
Arg::value_terminator must be its own argument on the CLI rather than being in a delimited list (#โ4025)
- (help) Line wrapping of help is now behind the existing
wrap_help feature flag, either enable it or hard code your wraps (#โ4258)
- (help) Make
DeriveDisplayOrder the default and removed the setting. To sort help, set next_display_order(None) (#โ2808)
- (help) Subcommand display order respects
Command::next_display_order instead of DeriveDisplayOrder and using its own initial display order value (#โ2808)
- (help) Subcommands are now listed before arguments. To get the old behavior, see
Command::help_template (#โ4132)
- (help) Help headings are now title cased, making any user-provided help headings inconsistent. To get the old behavior, see
Command::help_template, Arg::help_heading, and Command::subcommand_help_heading (#โ4132)
- (help) "Command" is used as the section heading for subcommands and
COMMAND for the value name. To get the old behavior, see Command::subcommand_help_heading and Arg::subcommand_value_name (#โ4132, #โ4155)
- (help) Whitespace in help output is now trimmed to ensure consistency regardless of how well a template matches the users needs. (#โ4132, #โ4156)
- (help) name/version/author are removed by default from help output. To get the old behavior, see
Command::help_template. (#โ4132, #โ4160)
- (help) Indentation for second-line usage changed. (#โ4132, #โ4188)
- (env) Parse
--help and --version like any ArgAction::SetTrue flag (#โ3776)
- (derive) Leave
Arg::id as verbatim casing, requiring updating of string references to other args like in conflicts_with or requires (#โ3282)
- (derive) Doc comments for
ValueEnum variants will now show up in --help (#โ3312)
- (derive) When deriving
Args, and ArgGroup is created using the type's name, reserving it for future use (#โ2621, #โ4209)
- (derive)
next_help_heading can now leak out of a #[clap(flatten)], like all other command settings (#โ4222)
Easier to catch changes:
- Looking up a group in
ArgMatches now returns the arg Ids, rather than the values to reduce overhead and offer more flexibility. (#โ4072)
- Changed
Arg::number_of_values (average-across-occurrences) to Arg::num_args (per-occurrence) (raw CLI args, not parsed values) (#โ2688, #โ4023)
num_args(0) no longer implies takes_value(true).multiple_values(true) (#โ4023)num_args(1) no longer implies multiple_values(true) (#โ4023)- Does not check default or env values, only what the user explicitly passes in (#โ4025)
- No longer terminates on delimited values (#โ4025)
- Replace
Arg::min_values (across all occurrences) with Arg::num_args(N..) (per occurrence) to reduce confusion over different value count APIs (#โ4023)
- Replace
Arg::max_values (across all occurrences) with Arg::num_args(1..=M) (per occurrence) to reduce confusion over different value count APIs (#โ4023)
- Replace
Arg::multiple_values(true) with Arg::num_args(1..) and Arg::multiple_values(false) with Arg::num_args(0) to reduce confusion over different value count APIs (#โ4023)
- Replace
Arg::takes_value(true) with Arg::num_args(1) and Arg::takes_value(false) with Arg::num_args(0) to reduce confusion over different value count APIs
- Remove
Arg::require_value_delimiter, either users could use Arg::value_delimiter or implement a custom parser with TypedValueParser as it was mostly to make multiple_values(true) act like multiple_values(false) and isn't needed anymore (#โ4026)
Arg::new("help") and Arg::new("version") no longer implicitly disable the
built-in flags and be copied to all subcommands, instead disable
the built-in flags (Command::disable_help_flag,
Command::disable_version_flag) and mark the custom flags as global(true). (#โ4056)Arg::short('h') no longer implicitly disables the short flag for help,
instead disable
the built-in flags (Command::disable_help_flag,
Command::disable_version_flag) provide your own Arg::new("help").long("help").action(ArgAction::Help).global(true). (#โ4056)ArgAction::SetTrue and ArgAction::SetFalse now prioritize Arg::default_missing_value over their standard behavior (#โ4000)- Changed
Arg::requires_ifs and Arg::default_value*_ifs* to taking an ArgPredicate, removing ambiguity with None when accepting owned and borrowed types (#โ4084)
- Removed
PartialEq and Eq from Command so we could change external subcommands to use a ValueParser (#โ3990)
- Various
Arg, Command, and ArgGroup calls were switched from accepting &[] to [] via IntoIterator to be more flexible (#โ4072)
Arg::short_aliases and other builder functions that took &[] need the & dropped (#โ4081)ErrorKind and Result moved into the error moduleErrorKind::EmptyValue replaced with ErrorKind::InvalidValue to remove an unnecessary special case (#โ3676, #โ3968)ErrorKind::UnrecognizedSubcommand replaced with ErrorKind::InvalidSubcommand to remove an unnecessary special case (#โ3676)- Changed the default type of
allow_external_subcommands from String to OsString as that is less likely to cause bugs in user applications (#โ3990)
- (help)
Command::render_usage now returns a StyledStr (#โ4248)
- (derive) Changed the default for arguments from
parse to value_parser, removing parse support (#โ3827, #โ3981)
#[clap(value_parser)] and #[clap(action)] are now redundant
- (derive)
subcommand_required(true).arg_required_else_help(true) is set instead of SubcommandRequiredElseHelp to give more meaningful errors when subcommands are missing and to reduce redundancy (#โ3280)
- (derive) Remove
arg_enum attribute in favor of value_enum to match the new name (we didn't have support in v3 to mark it deprecated) (#โ4127)
- (parser) Assert when the CLI looksup an unknown args when external subcommand support is enabled to help catch bugs (#โ3703)
- (assert) Sometimes
Arg::default_missing_value didn't require num_args(0..=N), now it does (#โ4023)
- (assert) Leading dashes in
Arg::long are no longer allowed (#โ3691)
- (assert) Disallow more
value_names than num_args (#โ2695)
- (assert) Always enforce that version is specified when the
ArgAction::Version is used
- (assert) Add missing
#[track_caller]s to make it easier to debug asserts
- (assert) Ensure
overrides_with IDs are valid
- (assert) Ensure no self-
overrides_with now that Actions replace it
- (assert) Ensure subcommand names are not duplicated
- (assert) Assert on
mut_arg receiving an invalid arg ID or mut_subcommand receiving an invalid command name
Compatibility
MSRV is now 1.60.0
Deprecated
Arg::use_value_delimiter in favor of Arg::value_delimiter to avoid having multiple ways of doing the same thingArg::requires_all in favor of Arg::requires_ifs now that it takes an ArgPredicate to avoid having multiple ways of doing the same thingArg::number_of_values in favor of Arg::num_args to clarify semantic differencesdefault_value_os, default_values_os, default_value_if_os, and default_value_ifs_os as the non _os variants now accept either a str or an OsStr (#โ4141)Arg::env_os in favor of Arg::envCommand::dont_collapse_args_in_usage is now the default (#โ4151)Command::trailing_var_arg in favor of Arg::trailing_var_arg to make it clearer which arg it is meant to apply to (#โ4187)Command::allow_hyphen_values in favor of Arg::allow_hyphen_values to make it clearer which arg it is meant to apply to (#โ4187)Command::allow_negative_numbers in favor of Arg::allow_negative_numbers to make it clearer which arg it is meant to apply to (#โ4187)- (help) Deprecated
Command::write_help and Command::write_long_help in favor of Command::render_help and Command::render_long_help (#โ4248)
- (derive)
structopt and clap attributes in favor of the more specific command, arg, and value to open the door for more features and clarify relationship to the builder (#โ1807, #โ4180)
- (derive)
#[clap(value_parser)] and #[clap(action)] defaulted attributes (its the default) (#โ3976)
Behavior Changes
- (help) With
wrap_help feature, if the terminal size cannot be determined, LINES and COLUMNS variables are used (#โ4186)
Features
Arg::num_args now accepts ranges, allowing setting both the minimum and maximum number of values per occurrence (#โ2688, #โ4023)- Allow non-bool
value_parsers for ArgAction::SetTrue / ArgAction::SetFalse (#โ4092)
- Add
From<&OsStr>, From<OsString>, From<&str>, and From<String> to value_parser! (#โ4257)
- Allow resetting most builder methods
- Can now pass runtime generated data to
Command, Arg, ArgGroup, PossibleValue, etc without managing lifetimes with the string feature flag (#โ2150, #โ4223)
- New default
error-context, help and usage feature flags that can be turned off for smaller binaries (#โ4236)
- Added
StyledStr::ansi() to Display with ANSI escape codes (#โ4248)
- (error)
Error::apply for changing the formatter for dropping binary size (#โ4111)
- (error)
Error::renderfor formatting the error into a StyledStr
- (help) Show
PossibleValue::help in long help (--help) (#โ3312)
- (help) New
{tab} variable for Command::help_template (#โ4161)
- (help)
Command::render_help and Command::render_long_help for formatting the error into a StyledStr (#โ3873, #โ4248)
- (help)
Command::render_usage now returns a StyledStr (#โ4248)
Fixes
- Verify
required is not used with conditional required settings (#โ3660)
- Replaced
cmd.allow_invalid_for_utf8_external_subcommands with cmd.external_subcommand_value_parser (#โ3733)
Arg::default_missing_value now applies per occurrence rather than if a value is missing across all occurrences (#โ3998)arg!(--long [value]) to accept 0..=1 per occurrence rather than across all occurrences, making it safe to use with ArgAction::Append (#โ4001)- Allow
OsStrs for Arg::{required_if_eq,required_if_eq_any,required_if_eq_all} (#โ4084)
- (help) With
wrap_help feature, if the terminal size cannot be determined, LINES and COLUMNS variables are used (#โ4186)
- (help) Use
Command::display_name in the help title rather than Command::bin_name
- (help) Show when a flag is
ArgAction::Count by adding an ... (#โ4003)
- (help) Use a more neutral palette for coloring (#โ4132, #โ4117)
- (help) Don't rely on ALL CAPS for help headers (#โ4132, #โ4123)
- (help) List subcommands first, focusing the emphasis on them (#โ4132, #โ4125)
- (help) Do not include global args in
cmd help help (#โ4131)
- (help) Use
[positional] in list when relevant (#โ4144)
- (help) Show all
[positional] in usage (#โ4151)
- (help) Polish up subcommands by referring to them as commands (#โ4132, #โ4155)
- (help) Trim extra whitespace to avoid artifacts from different uses of templates (#โ4132, #โ4156)
- (help) Hint to the user the difference between
-h / --help when applicable (#โ4132, #โ4159)
- (help) Shorten help by eliding name/version/author (#โ4132, #โ4160)
- (help) When short help is long enough to activate
next_line_help, don't add blank lines (#โ4132, #โ4190)
- (help) Make help output more dense (reducing horizontal whitespace) (#โ4132, #โ4192)
- (help) Separate subcommand flags with "," like option flags (#โ4232, #โ4235)
- (help) Quote the suggested help flag (#โ4220)
- (version) Use
Command::display_name rather than Command::bin_name (#โ3966)
- (parser) Always fill in
"" argument for external subcommands (#โ3263)
- (parser) Short flags now have higher precedence than hyphen values with
Arg::allow_hyphen_values, like Command::allow_hyphen_values (#โ4187)
- (parser) Prefer
InvalidSubcommand over UnknownArgument in more cases (#โ4219)
- (derive) Detect escaped external subcommands that look like built-in subcommands (#โ3703)
- (derive) Leave
Arg::id as verbatim casing (#โ3282)
- (derive) Default to
#[clap(value_parser, action)] instead of #[clap(parse)] (#โ3827)
Compare Source
[3.2.23] - 2022-10-24
Fixes
Compare Source
[3.2.22] - 2022-09-16
Fixes
- Unify dependencies on
terminal_size to the 0.2 release
Compare Source
[3.2.21] - 2022-09-12
Features
TypedValueParser::map to allow reusing existing value parsers for other purposes
Compare Source
[3.2.20] - 2022-09-02
Features
ArgMatches::get_count help for ArgAction::CountArgMatches::get_flag help for ArgAction::SetTrue / ArgAction::SetFalse
Compare Source
[3.2.19] - 2022-08-30
Fixes
- (help) Ensure required arguments for parent commands aren't shown in their subcommands when using
args_conflicts_with_subcommand
Compare Source
Fixes
- (help)
Command::print_help now respects Command::colored_help
- (derive) Improved error messages
Compare Source
Fixes
- (derive) Expose
#[clap(id = ...)] attribute to match Arg's latest API
Compare Source
Fixes
- Ensure required arguments appear in errors when they are also members of a group (#โ4004)
Compare Source
Features
- (derive) New
default_values_t and default_values_os_t attributes
Compare Source
Fixes
- A
multiple_values positional followed by another positional now works with multiple flags
Compare Source
Documentation
- Pulled in tutorials, cookbook, and derive reference into rustdoc
Compare Source
Fixes
- Allow an arg to declare a conflict with a group
Compare Source
Features
- Added
Arg::get_all_short_aliaes and Arg::get_all_aliases
Compare Source
Fixes
- Loosen lifetime on
Command::mut_subcommand
Compare Source
Features
- Added
Command::mut_subcommand to mirror Command::mut_arg
Compare Source
Fixes
- Global arguments should override env-sourced arguments
Compare Source
Fixes
- Don't panic when parsing
--=
Compare Source
Fixes
- (derive) Fix regression with
#[clap(default_value_os_t ...)] introduced in v3.2.3
Compare Source
Fixes
- (derive) Provide more clearer deprecation messages for
#[clap(parse)] attribute (#โ3832)
Compare Source
Fixes
- Moved deprecations to be behind the
deprecated Cargo.toml feature (#โ3830)
- For now, it is disabled by default though we are considering enabling it by
default as we release the next major version to help draw attention to the
deprecation migration path
Compare Source
Fixes
- (derive) Improve the highlighted code for deprecation warnings
gated behind unstable-v4
- (derive) Default to
#[clap(value_parser, action)] instead of #[clap(parse)] (#โ3827)
Compare Source
Fixes
- (help)
Command::print_help now respects Command::colored_help
- (derive) Improved error messages
Configuration
๐
Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
๐ฆ Automerge: Disabled by config. Please merge this manually once you are satisfied.
โป Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
๐ Ignore: Close this PR and you won't be reminded about this update again.
- [ ] If you want to rebase/retry this PR, check this box
This PR has been generated by Mend Renovate. View repository job log here.
renovate
29 Feb 6, 2023
2 Jan 17, 2022
379 Dec 25, 2022
5.5k Jan 2, 2023
36 Feb 16, 2023
44 Dec 27, 2022
3 Jul 4, 2022
14 Dec 21, 2022
3 Jan 31, 2023
3 May 15, 2023
5 Jun 10, 2023
2 Nov 8, 2022
3 Mar 6, 2022
14 Oct 23, 2022
5 Sep 4, 2022
2 Aug 26, 2022
69 Jul 11, 2022
587 Dec 26, 2022
136 Dec 21, 2022