ti-chi-bot
commented
1 year ago [REVIEW NOTIFICATION]
This pull request has been approved by:
- wuhuizuo
To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.
The full list of commands accepted by this bot can be found here.
Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.
github-actions[bot]
codecov[bot]
ti-chi-bot[bot]
This PR contains the following updates:
3.0.0-beta.2->3.2.25Release Notes
clap-rs/clap (clap)
### [`v3.2.25`](https://togithub.com/clap-rs/clap/releases/tag/v3.2.25) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.24...v3.2.25) #### \[3.2.25] - 2023-04-27 ##### Fixes - *(derive)* Resolve warnings in generated code ### [`v3.2.24`](https://togithub.com/clap-rs/clap/releases/tag/v3.2.24) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.23...v3.2.24) #### \[3.2.24] - 2023-04-25 ##### Fixes - *(derive)* Resolve warnings in generated code ### [`v3.2.23`](https://togithub.com/clap-rs/clap/releases/tag/v3.2.23) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.22...v3.2.23) #### \[3.2.23] - 2022-10-24 ##### Fixes - Upgrade to `textwrap` 0.16 ### [`v3.2.22`](https://togithub.com/clap-rs/clap/releases/tag/v3.2.22) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.21...v3.2.22) #### \[3.2.22] - 2022-09-16 ##### Fixes - Unify dependencies on `terminal_size` to the 0.2 release ### [`v3.2.21`](https://togithub.com/clap-rs/clap/releases/tag/v3.2.21) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.20...v3.2.21) #### \[3.2.21] - 2022-09-12 ##### Features - `TypedValueParser::map` to allow reusing existing value parsers for other purposes ### [`v3.2.20`](https://togithub.com/clap-rs/clap/releases/tag/v3.2.20) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.19...v3.2.20) #### \[3.2.20] - 2022-09-02 ##### Features - `ArgMatches::get_count` help for `ArgAction::Count` - `ArgMatches::get_flag` help for `ArgAction::SetTrue` / `ArgAction::SetFalse` ### [`v3.2.19`](https://togithub.com/clap-rs/clap/releases/tag/v3.2.19) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.18...v3.2.19) #### \[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` ### [`v3.2.18`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3218---2022-08-29) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.17...v3.2.18) ##### Fixes - *(help)* `Command::print_help` now respects `Command::colored_help` - *(derive)* Improved error messages ### [`v3.2.17`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3217---2022-08-12) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.16...v3.2.17) ##### Fixes - *(derive)* Expose `#[clap(id = ...)]` attribute to match Arg's latest API ### [`v3.2.16`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3216---2022-07-30) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.15...v3.2.16) ##### Fixes - Ensure required arguments appear in errors when they are also members of a group ([#4004](https://togithub.com/clap-rs/clap/issues/4004)) ### [`v3.2.15`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3215---2022-07-25) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.14...v3.2.15) ##### Features - *(derive)* New `default_values_t` and `default_values_os_t` attributes ### [`v3.2.14`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3214---2022-07-21) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.13...v3.2.14) ##### Fixes - A `multiple_values` positional followed by another positional now works with multiple flags ### [`v3.2.13`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3213---2022-07-19) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.12...v3.2.13) ##### Documentation - Pulled in tutorials, cookbook, and derive reference into rustdoc ### [`v3.2.12`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3212---2022-07-14) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.11...v3.2.12) ##### Fixes - Allow an arg to declare a conflict with a group ### [`v3.2.11`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3211---2022-07-13) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.10...v3.2.11) ##### Features - Added `Arg::get_all_short_aliaes` and `Arg::get_all_aliases` ### [`v3.2.10`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3210---2022-07-12) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.8...v3.2.10) ##### Fixes - Loosen lifetime on `Command::mut_subcommand` ### [`v3.2.8`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#328---2022-06-30) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.7...v3.2.8) ##### Features - Added `Command::mut_subcommand` to mirror `Command::mut_arg` ### [`v3.2.7`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#327---2022-06-28) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.6...v3.2.7) ##### Fixes - Global arguments should override env-sourced arguments ### [`v3.2.6`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#326---2022-06-21) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.5...v3.2.6) ##### Fixes - Don't panic when parsing `--=` ### [`v3.2.5`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#325---2022-06-15) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.4...v3.2.5) ##### Fixes - *(derive)* Fix regression with `#[clap(default_value_os_t ...)]` introduced in v3.2.3 ### [`v3.2.4`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#324---2022-06-14) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.3...v3.2.4) ##### Fixes - *(derive)* Provide more clearer deprecation messages for `#[clap(parse)]` attribute ([#3832](https://togithub.com/clap-rs/clap/issues/3832)) ### [`v3.2.3`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#323---2022-06-14) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.2...v3.2.3) ##### Fixes - Moved deprecations to be behind the `deprecated` Cargo.toml feature ([#3830](https://togithub.com/clap-rs/clap/issues/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 ### [`v3.2.2`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#322---2022-06-14) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.1...v3.2.2) ##### 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](https://togithub.com/clap-rs/clap/issues/3827)) ### [`v3.2.1`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3218---2022-08-29) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.2.0...v3.2.1) ##### Fixes - *(help)* `Command::print_help` now respects `Command::colored_help` - *(derive)* Improved error messages ### [`v3.2.0`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#320---2022-06-13) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.18...v3.2.0) ##### Compatibility MSRV is now 1.56.0 ([#3732](https://togithub.com/clap-rs/clap/issues/3732)) Behavior - Defaults no longer satisfy `required` and its variants ([#3793](https://togithub.com/clap-rs/clap/issues/3793)) - When misusing `ArgMatches::value_of` and friends, debug asserts were turned into panics Moving (old location deprecated) - `clap::{PossibleValue, ValueHint}` to `clap::builder::{PossibleValue, ValueHint}` - `clap::{Indices, OsValues, ValueSource, Values}` to `clap::parser::{Indices, OsValues, ValueSource, Values}` - `clap::ArgEnum` to `clap::ValueEnum` ([#3799](https://togithub.com/clap-rs/clap/issues/3799)) Replaced - `Arg::allow_invalid_utf8` with `Arg::value_parser(value_parser!(PathBuf))` ([#3753](https://togithub.com/clap-rs/clap/issues/3753)) - `Arg::validator` / `Arg::validator_os` with `Arg::value_parser` ([#3753](https://togithub.com/clap-rs/clap/issues/3753)) - `Arg::validator_regex` with users providing their own `builder::TypedValueParser` ([#3756](https://togithub.com/clap-rs/clap/issues/3756)) - `Arg::forbid_empty_values` with `builder::NonEmptyStringValueParser` / `builder::PathBufValueParser` ([#3753](https://togithub.com/clap-rs/clap/issues/3753)) - `Arg::possible_values` with `Arg::value_parser([...])`, `builder::PossibleValuesParser`, or `builder::EnumValueParser` ([#3753](https://togithub.com/clap-rs/clap/issues/3753)) - `Arg::max_occurrences` with `arg.action(ArgAction::Count).value_parser(value_parser!(u8).range(..N))` for flags ([#3797](https://togithub.com/clap-rs/clap/issues/3797)) - `Arg::multiple_occurrences` with `ArgAction::Append` or `ArgAction::Count` though positionals will need `Arg::multiple_values` ([#3772](https://togithub.com/clap-rs/clap/issues/3772), [#3797](https://togithub.com/clap-rs/clap/issues/3797)) - `Command::args_override_self` with `ArgAction::Set` ([#2627](https://togithub.com/clap-rs/clap/issues/2627), [#3797](https://togithub.com/clap-rs/clap/issues/3797)) - `AppSettings::NoAutoVersion` with `ArgAction` or `Command::disable_version_flag` ([#3800](https://togithub.com/clap-rs/clap/issues/3800)) - `AppSettings::NoHelpVersion` with `ArgAction` or `Command::disable_help_flag` / `Command::disable_help_subcommand` ([#3800](https://togithub.com/clap-rs/clap/issues/3800)) - `ArgMatches::{value_of, value_of_os, value_of_os_lossy, value_of_t}` with `ArgMatches::{get_one,remove_one}` ([#3753](https://togithub.com/clap-rs/clap/issues/3753)) - `ArgMatches::{values_of, values_of_os, values_of_os_lossy, values_of_t}` with `ArgMatches::{get_many,remove_many}` ([#3753](https://togithub.com/clap-rs/clap/issues/3753)) - `ArgMatches::is_valid_arg` with `ArgMatches::{try_get_one,try_get_many}` ([#3753](https://togithub.com/clap-rs/clap/issues/3753)) - `ArgMatches::occurrences_of` with `ArgMatches::value_source` or `ArgAction::Count` ([#3797](https://togithub.com/clap-rs/clap/issues/3797)) - `ArgMatches::is_present` with `ArgMatches::contains_id` or `ArgAction::SetTrue` ([#3797](https://togithub.com/clap-rs/clap/issues/3797)) - `ArgAction::StoreValue` with `ArgAction::Set` or `ArgAction::Append` ([#3797](https://togithub.com/clap-rs/clap/issues/3797)) - `ArgAction::IncOccurrences` with `ArgAction::SetTrue` or `ArgAction::Count` ([#3797](https://togithub.com/clap-rs/clap/issues/3797)) - *(derive)* `#[clap(parse(...))]` replaced with: ([#3589](https://togithub.com/clap-rs/clap/issues/3589), [#3794](https://togithub.com/clap-rs/clap/issues/3794)) - For default parsers (no `parse` attribute), deprecation warnings can be silenced by opting into the new behavior by adding either `#[clap(action)]` or `#[clap(value_parser)]` (ie requesting the default behavior for these attributes). Alternatively, the `unstable-v4` feature changes the default away from `parse` to `action`/`value_parser`. - For `#[clap(parse(from_flag))]` replaced with `#[clap(action = ArgAction::SetTrue)]` ([#3794](https://togithub.com/clap-rs/clap/issues/3794)) - For `#[clap(parse(from_occurrences))]` replaced with `#[clap(action = ArgAction::Count)]` though the field's type must be `u8` ([#3794](https://togithub.com/clap-rs/clap/issues/3794)) - For `#[clap(parse(from_os_str)]` for `PathBuf`, replace it with `#[clap(value_parser)]` (as mentioned earlier this will call `value_parser!(PathBuf)` which will auto-select the right `ValueParser` automatically). - For `#[clap(parse(try_from_str = ...)]`, replace it with `#[clap(value_parser = ...)]` - For most other cases, a type implementing `TypedValueParser` will be needed and specify it with `#[clap(value_parser = ...)]` ##### Features - Parsed, typed arguments via `Arg::value_parser` / `ArgMatches::{get_one,get_many}` ([#2683](https://togithub.com/clap-rs/clap/issues/2683), [#3732](https://togithub.com/clap-rs/clap/issues/3732)) - Several built-in `TypedValueParser`s available with an API open for expansion - `value_parser!(T)` macro for selecting a parser for a given type ([#3732](https://togithub.com/clap-rs/clap/issues/3732)) and open to expansion via the `ValueParserFactory` trait ([#3755](https://togithub.com/clap-rs/clap/issues/3755)) - `[&str]` is implicitly a value parser for possible values - All `ArgMatches` getters do not assume required arguments ([#2505](https://togithub.com/clap-rs/clap/issues/2505)) - Add `ArgMatches::remove_*` variants to transfer ownership - Add `ArgMatches::try_*` variants to avoid panics for developer errors ([#3621](https://togithub.com/clap-rs/clap/issues/3621)) - Add a `get_raw` to access the underlying `OsStr`s - `PathBuf` value parsers imply `ValueHint::AnyPath` for completions ([#3732](https://togithub.com/clap-rs/clap/issues/3732)) - Explicit control over parsing via `Arg::action` ([#3774](https://togithub.com/clap-rs/clap/issues/3774)) - `ArgAction::StoreValue`: existing `takes_value(true)` behavior - `ArgAction::IncOccurrences`: existing `takes_value(false)` behavior - `ArgAction::Help`: existing `--help` behavior - `ArgAction::Version`: existing `--version` behavior - `ArgAction::Set`: Overwrite existing values (like `Arg::multiple_occurrences` mixed with `Command::args_override_self`) ([#3777](https://togithub.com/clap-rs/clap/issues/3777)) - `ArgAction::Append`: like `Arg::multiple_occurrences` ([#3777](https://togithub.com/clap-rs/clap/issues/3777)) - `ArgAction::SetTrue`: Treat `--flag` as `--flag=true` ([#3775](https://togithub.com/clap-rs/clap/issues/3775)) - Implies `Arg::default_value("false")` ([#3786](https://togithub.com/clap-rs/clap/issues/3786)) - Parses `Arg::env` via `Arg::value_parser` - `ArgAction::SetFalse`: Treat `--flag` as `--flag=false` ([#3775](https://togithub.com/clap-rs/clap/issues/3775)) - Implies `Arg::default_value("true")` ([#3786](https://togithub.com/clap-rs/clap/issues/3786)) - Parses `Arg::env` via `Arg::value_parser` - `ArgAction::Count`: Treat `--flag --flag --flag` as `--flag=1 --flag=2 --flag=3` ([#3775](https://togithub.com/clap-rs/clap/issues/3775)) - Implies `Arg::default_value("0")` ([#3786](https://togithub.com/clap-rs/clap/issues/3786)) - Parses `Arg::env` via `Arg::value_parser` - *(derive)* Opt-in to new `Arg::value_parser` / `Arg::action` with either `#[clap(value_parser)]` ([#3589](https://togithub.com/clap-rs/clap/issues/3589), [#3742](https://togithub.com/clap-rs/clap/issues/3742)) / `#[clap(action)]` attributes ([#3794](https://togithub.com/clap-rs/clap/issues/3794)) - Default `ValueParser` is determined by `value_parser!` ([#3199](https://togithub.com/clap-rs/clap/issues/3199), [#3496](https://togithub.com/clap-rs/clap/issues/3496)) - Default `ArgAction` is determine by a hard-coded lookup on the type ([#3794](https://togithub.com/clap-rs/clap/issues/3794)) - `Command::multicall` is now stable for busybox-like programs and REPLs ([#2861](https://togithub.com/clap-rs/clap/issues/2861), [#3684](https://togithub.com/clap-rs/clap/issues/3684)) - `ArgMatches::{try_,}contains_id` for checking if there are values for an argument that mirrors the new `get_{one,many}` API ##### Fixes - Don't correct argument id in `default_value_ifs_os`([#3815](https://togithub.com/clap-rs/clap/issues/3815)) *parser* - Set `ArgMatches::value_source` and `ArgMatches::occurrences_of` for external subcommands ([#3732](https://togithub.com/clap-rs/clap/issues/3732)) - Use value delimiter for `Arg::default_missing_values` ([#3761](https://togithub.com/clap-rs/clap/issues/3761), [#3765](https://togithub.com/clap-rs/clap/issues/3765)) - Split`Arg::default_value` / `Arg::env` on value delimiters independent of whether `--` was used ([#3765](https://togithub.com/clap-rs/clap/issues/3765)) - Allow applying defaults to flags ([#3294](https://togithub.com/clap-rs/clap/issues/3294), 3775) - Defaults no longer satisfy `required` and its variants ([#3793](https://togithub.com/clap-rs/clap/issues/3793)) ### [`v3.1.18`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3118---2022-05-10) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.17...v3.1.18) ##### Fixes - Fix deprecated `arg_enum!` for users migrating to clap3 ([#3717](https://togithub.com/clap-rs/clap/issues/3717)) - Verify all `required_unless_present_all` arguments exist - Verify group members exist before processing group members ([#3711](https://togithub.com/clap-rs/clap/issues/3711)) - *(help)* Use `...` when not enough `value_names` are supplied **gated behind `unstable-v4`** - Verify `required` is not used with conditional required settings ([#3660](https://togithub.com/clap-rs/clap/issues/3660)) - Disallow more `value_names` than `number_of_values` ([#2695](https://togithub.com/clap-rs/clap/issues/2695)) - *(parser)* Assert on unknown args when using external subcommands ([#3703](https://togithub.com/clap-rs/clap/issues/3703)) - *(parser)* Always fill in `""` argument for external subcommands ([#3263](https://togithub.com/clap-rs/clap/issues/3263)) - *(derive)* Detect escaped external subcommands that look like built-in subcommands ([#3703](https://togithub.com/clap-rs/clap/issues/3703)) - *(derive)* Leave `Arg::id` as `verbatim` casing ([#3282](https://togithub.com/clap-rs/clap/issues/3282)) ### [`v3.1.17`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3117---2022-05-06) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.16...v3.1.17) ##### Fixes - Allow value names for `arg!` macro to have dashes when quoted, like longs ### [`v3.1.16`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3116---2022-05-06) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.15...v3.1.16) ##### Fixes - *(parser)* `Arg::exclusive` overrides `Arg::required`, like other conflicts - *(error)* Don't duplicate arguments in usage - *(error)* Don't show hidden arguments in conflict error usage - *(help)* New `help_template` variable `{name}` to fix problems with `{bin}` - *(help)* Don't wrap URLs **gated behind `unstable-v4`** - Leading dashes in `Arg::long` are no longer allowed - *(help)* Use `Command::display_name` in the help title rather than `Command::bin_name` ### [`v3.1.15`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3115---2022-05-02) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.14...v3.1.15) ##### Fixes - *(error)* Render actual usage for unrecognized subcommands - *(multicall)* Improve bad command error - *(multicall)* Always require a multicall command - *(multicall)* Disallow arguments on multicall parent command - *(multicall)* More consistent with rest of clap errors ### [`v3.1.14`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3114---2022-05-01) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.13...v3.1.14) ##### Fixes - Panic when calling `Command::build` with a required positional argument nested several layers in subcommands ### [`v3.1.13`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3113---2022-04-30) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.12...v3.1.13) ##### Fixes - Help subcommand and `Command::write_help` now report required arguments in usage in more circumstances - Unknown subcommand for help subcommand flag now reports an error with more context - More details reported when using `debug` feature - Allow disabling `color` feature with `debug` feature enabled ### [`v3.1.12`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3112---2022-04-22) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.11...v3.1.12) ##### Fixes - Regression in 3.1.11 where the (output) streams were crossed ### [`v3.1.11`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3111---2022-04-22) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.10...v3.1.11) ##### Fixes - Implied conflicts override `Arg::required`, making the behavior consistent with how we calculate conflicts for error reporting - Members of a mutually exclusive `ArgGroup` override `Arg::required`, making the behavior consistent with how we calculate conflicts for error reporting - `Arg::overrides_with` always override `Arg::required`, not just when the parser processes an override ### [`v3.1.10`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3110---2022-04-19) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.9...v3.1.10) ##### Features - Expose `Command::build` for custom help generation or other command introspection needs ### [`v3.1.9`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#319---2022-04-15) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.8...v3.1.9) ##### Fixes - Pin the `clap_derive` version so a compatible version is always used with `clap` ### [`v3.1.8`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#318---2022-04-01) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.7...v3.1.8) ##### Fixes - Add `Debug` impls to more types ### [`v3.1.7`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#317---2022-03-31) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.6...v3.1.7) ##### Fixes - *(derive)* Abort, rather than ignore, when deriving `ArgEnum` with non-unit unskipped variants ### [`v3.1.6`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#316---2022-03-07) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.5...v3.1.6) ##### Fixes - Don't panic when validating delimited defaults ([#3541](https://togithub.com/clap-rs/clap/issues/3541)) - Make it clearer that `cargo` feature is needed - Documentation improvements ### [`v3.1.5`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#315---2022-03-02) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.4...v3.1.5) ##### Fixes - Dependency upgrade ### [`v3.1.4`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#314---2022-03-02) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.3...v3.1.4) ##### Features - *(help)* Show `PossibleValue::help` in long help (`--help`) **(gated behind `unstable-v4`)** ([#3312](https://togithub.com/clap-rs/clap/issues/3312)) ### [`v3.1.3`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#313---2022-02-28) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.2...v3.1.3) ##### Fixes - Don't panic when validating delimited defaults ([#3514](https://togithub.com/clap-rs/clap/issues/3514)) ### [`v3.1.2`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#312---2022-02-23) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.1...v3.1.2) ##### Fixes - *(derive)* Allow other attribute with a subcommand that has subcommands ##### Documentation - *(examples)* List example topics - *(derive)* Clarify syntax and relation to builder API ### [`v3.1.1`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3118---2022-05-10) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.1.0...v3.1.1) ##### Fixes - Fix deprecated `arg_enum!` for users migrating to clap3 ([#3717](https://togithub.com/clap-rs/clap/issues/3717)) - Verify all `required_unless_present_all` arguments exist - Verify group members exist before processing group members ([#3711](https://togithub.com/clap-rs/clap/issues/3711)) - *(help)* Use `...` when not enough `value_names` are supplied **gated behind `unstable-v4`** - Verify `required` is not used with conditional required settings ([#3660](https://togithub.com/clap-rs/clap/issues/3660)) - Disallow more `value_names` than `number_of_values` ([#2695](https://togithub.com/clap-rs/clap/issues/2695)) - *(parser)* Assert on unknown args when using external subcommands ([#3703](https://togithub.com/clap-rs/clap/issues/3703)) - *(parser)* Always fill in `""` argument for external subcommands ([#3263](https://togithub.com/clap-rs/clap/issues/3263)) - *(derive)* Detect escaped external subcommands that look like built-in subcommands ([#3703](https://togithub.com/clap-rs/clap/issues/3703)) - *(derive)* Leave `Arg::id` as `verbatim` casing ([#3282](https://togithub.com/clap-rs/clap/issues/3282)) ### [`v3.1.0`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#310---2022-02-16) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.0.14...v3.1.0) ##### Compatibility Changes in behavior of note that are not guaranteed to be compatible across releases: - *(help)* `help` subcommand shows long help like `--help`, rather than short help (`-h`), deprecated `clap::AppSettings::UseLongFormatForHelpSubcommand` ([#3440](https://togithub.com/clap-rs/clap/issues/3440)) - *(help)* Pacman-style subcommands are now ordered the same as usage errors ([#3470](https://togithub.com/clap-rs/clap/issues/3470)) - *(help)* Pacman-style subcommands use standard alternate syntax in usage ([#3470](https://togithub.com/clap-rs/clap/issues/3470)) ##### Deprecations - `clap::Command` is now preferred over `clap::App` ([#3089](https://togithub.com/clap-rs/clap/issues/3089) in [#3472](https://togithub.com/clap-rs/clap/issues/3472)) - `clap::command!` is now preferred over `clap::app_from_crate` ([#3089](https://togithub.com/clap-rs/clap/issues/3089) in [#3474](https://togithub.com/clap-rs/clap/issues/3474)) - `clap::CommandFactory::command` is now preferred over `clap::IntoApp::into_app` ([#3089](https://togithub.com/clap-rs/clap/issues/3089) in [#3473](https://togithub.com/clap-rs/clap/issues/3473)) - *(help)* `help` subcommand shows long help like `--help`, rather than short help (`-h`), deprecated `clap::AppSettings::UseLongFormatForHelpSubcommand` ([#3440](https://togithub.com/clap-rs/clap/issues/3440)) - *(error)* Deprecate `clap::AppSettings::WaitOnError`, leaving it to the user to implement - *(validation)* `clap::Command::subcommand_required(true).arg_required_else_help(true)` is now preferred over `clap::AppSettings::SubcommandRequiredElseHelp` ([#3280](https://togithub.com/clap-rs/clap/issues/3280)) - *(builder)* `clap::AppSettings` are nearly all deprecated and replaced with builder methods and getters ([#2717](https://togithub.com/clap-rs/clap/issues/2717)) - *(builder)* `clap::ArgSettings` is deprecated and replaced with builder methods and getters ([#2717](https://togithub.com/clap-rs/clap/issues/2717)) - *(builder)* `clap::Arg::id` and `clap::ArgGroup::id` are now preferred over `clap::Arg::name` and `clap::ArgGroup::name` ([#3335](https://togithub.com/clap-rs/clap/issues/3335)) - *(help)* `clap::Command::next_help_heading` is now preferred over `clap::Command::help_heading` ([#1807](https://togithub.com/clap-rs/clap/issues/1807), [#1553](https://togithub.com/clap-rs/clap/issues/1553)) - *(error)* `clap::error::ErrorKind` is now preferred over `clap::ErrorKind` ([#3395](https://togithub.com/clap-rs/clap/issues/3395)) - *(error)* `clap::Error::kind()` is now preferred over `clap::Error::kind` - *(error)* `clap::Error::context()` is now preferred over `clap::Error::info` ([#2628](https://togithub.com/clap-rs/clap/issues/2628)) Note: All items deprecated in 3.0.0 are now hidden in the documentation. ([#3458](https://togithub.com/clap-rs/clap/issues/3458)) ##### Features - *(matches)* Add `clap::ArgMatches::value_source` to determine what insert the value ([#1345](https://togithub.com/clap-rs/clap/issues/1345)) - *(help)* Override derived display order with `clap::Command::next_display_order` ([#1807](https://togithub.com/clap-rs/clap/issues/1807)) - *(error)* Show possible values when an argument doesn't have a value ([#3320](https://togithub.com/clap-rs/clap/issues/3320)) - *(error)* New `clap::Error::context` API to open the door for fully-custom error messages ([#2628](https://togithub.com/clap-rs/clap/issues/2628)) - *(error)* `clap::error::ErrorKind` now implements `Display` ##### Fixes - *(builder)* Some functions were renamed for consistency and fixing spelling issues - *(builder)* Allow `clap::Command::color` to override previous calls ([#3449](https://togithub.com/clap-rs/clap/issues/3449)) - *(parse)* Propagate globals with multiple subcommands ([#3428](https://togithub.com/clap-rs/clap/issues/3428)) - *(validation)* Give `ArgRequiredElseHelp` precedence over `SubcommandRequired` ([#3456](https://togithub.com/clap-rs/clap/issues/3456)) - *(validation)* Default values no longer count as "present" for conflicts, requires, `clap::Command::arg_required_else_help`, etc ([#3076](https://togithub.com/clap-rs/clap/issues/3076), [#1264](https://togithub.com/clap-rs/clap/issues/1264)) - *(assert)* Report invalid defaults ([#3202](https://togithub.com/clap-rs/clap/issues/3202)) - *(help)* Clarify how to handle `-h` conflicts ([#3403](https://togithub.com/clap-rs/clap/issues/3403)) - *(help)* Make it easier to debug the addition of help flags ([#3425](https://togithub.com/clap-rs/clap/issues/3425)) - *(help)* Pacman-style subcommands are now separated with spaces ([#3470](https://togithub.com/clap-rs/clap/issues/3470)) - *(help)* Pacman-style subcommands are now ordered the same as usage errors ([#3470](https://togithub.com/clap-rs/clap/issues/3470)) - *(help)* Pacman-style subcommands use standard alternate syntax in usage ([#3470](https://togithub.com/clap-rs/clap/issues/3470)) - *(error)* Be consistent in showing of required attributes between errors / usage ([#3390](https://togithub.com/clap-rs/clap/issues/3390)) - *(error)* Show user's order of possible values, like in `--help` ([#1549](https://togithub.com/clap-rs/clap/issues/1549)) - *(error)* Allow customizing error type in `clap::error::Result` ([#3395](https://togithub.com/clap-rs/clap/issues/3395)) ##### Performance - *(error)* Reduced stack size of `clap::Error` ([#3395](https://togithub.com/clap-rs/clap/issues/3395)) ##### Documentation - *(builder)* Correct data take accepted for `clap::Arg::validator` - *(derive)* Clarify `parse` attribute - *(tutorial)* Demonstrate custom parsing - *(example)* Consistently list out required feature flags ([#3448](https://togithub.com/clap-rs/clap/issues/3448)) ### [`v3.0.14`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3014---2022-02-01) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.0.13...v3.0.14) ##### Features - Added `ArgMatches::args_present()` to check if any args are present - Added `Error::kind()` as we work to deprecate direct member access for `Error` - Added `App::get_version` - Added `App::get_long_version` - Added `App::get_author` - Added `App::get_subcommand_help_heading` - Added `App::get_subcommand_value_name` - Added `App::get_after_help` - Added `App::get_after_long_help` ##### Performance - Misc binary size reductions ### [`v3.0.13`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3013---2022-01-26) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.0.12...v3.0.13) ##### Fixes - Show optional flag values wrapped in `[]` ### [`v3.0.12`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3012---2022-01-24) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.0.11...v3.0.12) ##### Features - *(derive)* Support for `default_value_os_t` ### [`v3.0.11`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3011---2022-01-24) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.0.10...v3.0.11) ##### Fixes - Ensure conflicts work when they target a group with a default value ### [`v3.0.10`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3010---2022-01-18) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.0.9...v3.0.10) ##### Fixes - Resolve `panic!` from v3.0.8 when using `global_setting(PropagateVersion)`. ### [`v3.0.9`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#309---2022-01-17) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.0.8...v3.0.9) ##### Features - Added `App::find_subcommand_mut` ### [`v3.0.8`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#308---2022-01-17) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.0.7...v3.0.8) ##### Fixes - Respected `DisableColoredHelp` on `cmd help help` - Provide a little more context when completing arguments for `cmd help` - Provide more context for some asserts - Small documentation improvements ### [`v3.0.7`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#307---2022-01-12) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.0.6...v3.0.7) ##### Fixes - Shift more asserts from parsing to `App` building (ie will now run in `App::debug_assert`) **derive** - Documentation fixes ### [`v3.0.6`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#306---2022-01-10) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.0.5...v3.0.6) ##### Fixes **derive** - Don't assume user does `use clap::ArgEnum` ([#3277](https://togithub.com/clap-rs/clap/issues/3277)) - Documentation fixes ### [`v3.0.5`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#305---2022-01-05) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.0.4...v3.0.5) ##### Fixes - Provide hack to workaround [inability to detect external subcommands aliasing when escaped](https://togithub.com/clap-rs/clap/issues/3263) ([#3264](https://togithub.com/clap-rs/clap/issues/3264)) **docs:** - Cleaned up code blocks in tutorials ([#3261](https://togithub.com/clap-rs/clap/issues/3261)) - Clean up quotes in `ArgMatches` asserts - List correct replacement for deprecated `Parser::from_clap` ([#3257](https://togithub.com/clap-rs/clap/issues/3257)) ### [`v3.0.4`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#304---2022-01-04) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.0.3...v3.0.4) ##### Features - For very limited cases, like `cargo`, expose `ArgMatches::is_valid_arg` to avoid panicing on undefined arguments ### [`v3.0.3`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#303---2022-01-04) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.0.2...v3.0.3) ##### Fixes - Specify cause of debug assert failure ### [`v3.0.2`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#302---2022-01-04) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.0.1...v3.0.2) ##### Fixes - Ignore `Last` when checking hyphen values (see [#3249](https://togithub.com/clap-rs/clap/issues/3249) for details) - Help catch bugs with `#[must_use]` ### [`v3.0.1`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#3014---2022-02-01) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.0.0...v3.0.1) ##### Features - Added `ArgMatches::args_present()` to check if any args are present - Added `Error::kind()` as we work to deprecate direct member access for `Error` - Added `App::get_version` - Added `App::get_long_version` - Added `App::get_author` - Added `App::get_subcommand_help_heading` - Added `App::get_subcommand_value_name` - Added `App::get_after_help` - Added `App::get_after_long_help` ##### Performance - Misc binary size reductions ### [`v3.0.0`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#300---2021-12-31) [Compare Source](https://togithub.com/clap-rs/clap/compare/v3.0.0-rc.13...v3.0.0) **Note:** clap v3 has been in development for several years and has changed hands multiple times. Unfortunately, our changelog might be incomplete, whether in changes or their motivation. ##### Highlights A special thanks to the maintainers, contributors, beta users, and sponsors who have helped along this journey, especially kbknapp. **[StructOpt](https://docs.rs/structopt/) Integration** [StructOpt](https://docs.rs/structopt/) provides a serde-like declarative approach to defining your parser. The main benefits we've seen so far from integrating are: - Tighter feedback between the design of clap and the derives - More universal traits. Crates exist for common CLI patterns ([example](https://togithub.com/rust-cli/clap-verbosity-flag)) and we've re-designed the `StructOpt` traits so crates built on clap3 can be reused not just with other derives but also people using the builder API. People can even hand implement these so people using the builder API won't have the pay the cost for derives. **Custom Help Headings** Previously, clap automatically grouped arguments in the help as either `ARGS`, `FLAGS`, `OPTIONS`, and `SUBCOMMANDS`. You can now override the default group with `Arg::help_heading` and `App::subcommand_help_heading`. To apply a heading to a series of arguments, you can set `App::help_heading`. **Deprecations** While a lot of deprecations have been added to clean up the API (overloaded meaning of `Arg::multiple`) or make things more consistent, some particular highlights are: - `clap_app!` has been deprecated in favor of the builder API with `arg!` ([clap-rs/clap#2835](https://togithub.com/clap-rs/clap/issues/2835)) - `Arg::from_usage` has been deprecated in favor of `arg!` ([clap-rs/clap#3087](https://togithub.com/clap-rs/clap/issues/3087)) - [Porting example](https://togithub.com/clap-rs/clap/commit/4c4a2b86a08ef9e2d63010aab4909dd5a013dfb0) - The YAML API has been deprecated in favor the builder or derive APIs ([clap-rs/clap#3087](https://togithub.com/clap-rs/clap/issues/3087)) ##### Migrating **From clap v2** 1. Add CLI tests, `-h` and `--help` output at a minimum (recommendation: [trycmd](https://docs.rs/trycmd/) for snapshot testing) 2. Update your dependency 1. *If you use `no-default-features`:* add the `std` feature 3. Resolve compiler errors 4. Resolve behavior changes 1. Refactor your `App` creation to a function and add a test similar to the one below, resolving any of its assertions 2. Look over the "subtle changes" under BREAKING CHANGES 3. *If using builder:* test your application under various circumstances to see if `ArgMatches` asserts regarding `AllowInvalidUtf8`. 5. *At your leisure:* resolve deprecation notices Example test: ```rust fn app() -> clap::App<'static> { ... } #[test] fn verify_app() { app().debug_assert(); } ``` **From structopt 0.3.25** 1. Add CLI tests, `-h` and `--help` output at a minimum (recommendation: [trycmd](https://docs.rs/trycmd/) for snapshot testing) 2. Replace your dependency from `structopt = "..."` to `clap = { version = "3.0", features = ["derive"] }` 1. *If you use `no-default-features`:* add the `std` feature 3. Resolve compiler errors, including 1. Update your `use` statements from `structopt` and `structopt::clap` to `clap` 4. Resolve behavior changes 1. Add a test similar to the one below, resolving any of its assertions 2. Look over the "subtle changes" under BREAKING CHANGES 5. *At your leisure:* resolve deprecation notices Example test: ```rust #[derive(clap::StructOpt)] struct Args { ... } #[test] fn verify_app() { use clap::IntoApp; Args::into_app().debug_assert() } ``` **From clap v3.0.0-beta.5** 1. Add CLI tests, `-h` and `--help` output at a minimum (recommendation: [trycmd](https://docs.rs/trycmd/) for snapshot testing) 2. Update your dependency 1. Add in `derive`, `env`, `cargo`, or `unicode` feature flags as needed 3. Resolve compiler errors 1. *If you use `yaml`, `clap_app!`, or usage parser:* revert any changes you made for clap3 2. Change `Arg::about` `Arg::long_about` back to `help` and `long_help` and change `PossibleValue::about` to `help` ([clap-rs/clap#3075](https://togithub.com/clap-rs/clap/issues/3075)) 3. Change `AppSettings::HelpRequired` to `AppSettings::HelpExpected` 4. Change `PossibleValue::hidden` to `PossibleValue::hide` 5. Change `App::subcommand_placeholder` to `App::subcommand_value_name` / `App::subcommand_help_heading` 4. Resolve behavior changes 1. Add the above listed test appropriate for your application and resolve any problems it reports 2. *If using `derive`:* see the structopt breaking changes section for `Vec` changes 3. *If using builder:* test your application under various circumstances to see if `ArgMatches` asserts regarding `AllowInvalidUtf8`. 5. *At your leisure:* resolve deprecation notices ##### BREAKING CHANGES **From clap 2** Subtle changes (i.e. compiler won't catch): - `AppSettings::UnifiedHelpMessage` is now default behaviour - `{flags}` and `{unified}` will assert if present in `App::help_template` - See [clap-rs/clap#2807](https://togithub.com/clap-rs/clap/issues/2807) - `AppSettings::EnableColoredHelp` is now the default behavior but can be opted-out with `AppSettings::DisableColoredHelp` ([clap-rs/clap#2806](https://togithub.com/clap-rs/clap/issues/2806)) - `App::override_usage` no longer implies a leading `\t`, allowing multi lined usages - `Arg::require_equals` no longer implies `ArgSettings::ForbidEmptyValues` ([#2233](https://togithub.com/clap-rs/clap/issues/2233)) - `Arg::require_delimiter` no longer implies `ArgSettings::TakesValue` and `ArgSettings::UseValueDelimiter` ([#2233](https://togithub.com/clap-rs/clap/issues/2233)) - `Arg::env`, `Arg::env_os`, `Arg::last`, `Arg::require_equals`, `Arg::allow_hyphen_values`, `Arg::hide_possible_values`, `Arg::hide_default_value`, `Arg::hide_env_values`, `Arg::case_insensitive` and `Arg::multiple_values` no longer imply `ArgSettings::TakesValue` ([#2233](https://togithub.com/clap-rs/clap/issues/2233)) - `ArgMatches::is_present` no longer checks subcommand names - Some env variable values are now considered false for flags, not just "not-present" ([clap-rs/clap#2539](https://togithub.com/clap-rs/clap/issues/2539)) - Changed `...`s meaning in usage parser. Before, it always meant `multiple` which is still true for `--option [val]...`. Now `[name]... --option [val]` results in `ArgSettings::MultipleOccurrences`. - Usage exit code changed from `1` to `2` ([clap-rs/clap#1327](https://togithub.com/clap-rs/clap/issues/1327)) - Reject `--foo=bar` when `takes_value(false)` ([clap-rs/clap#1543](https://togithub.com/clap-rs/clap/issues/1543)) - No longer accept an arbitrary number of `-` for long arguments (`-----long`) Easier to catch changes: - When using `no-default-features`, you now have to specify the `std` feature (reserved for future work) - Gated env support behind `env` feature flag - Impacts `Arg::env`, `Arg::env_os`, `Arg::hide_env_values`, `ArgSettings::HideEnvValues` - See [clap-rs/clap#2694](https://togithub.com/clap-rs/clap/pull/2694) - Gated crate information behind `cargo` feature flag - Impacts `crate_name!`, `crate_version!`, `crate_authors!`, `crate_description!`, `app_from_crate!` - `AppSettings::StrictUtf8` is now default behaviour and asserts if `AppSettings::AllowInvalidUtf8ForExternalSubcommands` and `ArgSettings::AllowInvalidUtf8` and `ArgMatches::value_of_os` aren't used together - `AppSettings::AllowInvalidUtf8` has been removed - [clap-rs/clap#751](https://togithub.com/clap-rs/clap/issues/751) - `Arg::short` and `Arg::value_delimiter` now take a `char` instead of a `&str` - `ArgMatches` panics on unknown arguments - Removed `VersionlessSubcommands`, making it the default (see [clap-rs/clap#2812](https://togithub.com/clap-rs/clap/issues/2812)) - Completion generation has been split out into [clap_complete](./clap_complete). - Removed `ArgSettings::EmptyValues` in favor of `ArgSettings::ForbidEmptyValues` - Validator signatures have been loosed: - `Arg::validator` now takes first argument as `Fn(&str) -> ResultConfiguration
📅 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.
This PR has been generated by Mend Renovate. View repository job log here.