clap-rs v3.0.0-beta.5 Release Notes
Release Date: 2021-10-18 // over 2 years ago-
๐ฅ BREAKING CHANGES
- ๐ Renamed Features
unicode_help
tounicode
to encompass more functionality
- Gated behind features
App::replace
is now gated behindunstable-replace
- โ Removed
derive
requirementclap::ArgEnum
clap::Args
clap::FromArgMatches
clap::IntoApp
clap::Subcommand
- ๐ Renamed Traits
clap::Clap
=>clap::Parser
- ๐ Renamed Methods
App::generate_usage
=>App::render_usage
- โ Removed Settings
AppSettings::DisableVersionForSubcommands
is now default behaviourAppSettings::ColoredHelp
: we are now relying solely on thecolor
feature flag andApp::color
methodAppSettings::StrictUtf8
is now default behaviourAppSettings::AllowInvalidUtf8
in favor ofArgSettings::AllowInvalidUtf8
AppSettings::UnifiedHelpMessage
is now default behaviourAppSettings::ColorAlways
in favor ofApp::color
AppSettings::ColorNever
in favor ofApp::color
AppSettings::ColorAuto
in favor ofApp::color
- โ Removed methods
- App
App::get_flags
App::get_positionals_with_no_heading
App::get_flags_with_no_heading
App::get_opts_with_no_heading
App::stop_custom_headings
in favor ofApp:help_heading(None)
- Error
Error::with_description
in favor ofApp::error
- ArgEnum
ArgEnum::as_arg
in favor ofArgEnum::to_arg_value
- clap_generate::Generator
Generator::all_subcommands
Generator::find_subcommand_with_path
Generator::subcommands
Generator::shorts_and_visible_aliases
Generator::longs_and_visible_aliases
Generator::flags
- โ Removed
ArgEnum::VARIANTS
in favor ofArgEnum::value_variants
- ๐ Deprecated
clap::clap_app!
in favor of other builders
- ๐ Changed
App::get_possible_values
returnsOption<&[ArgValue]>
nowRegexRef
is now an enum also allowingRegexSet
to be usedclap_generate::Generator::file_name
andclap_generate::Generator::generate
now take&self
clap_generate::generate
andclap_generate::generate_to
now takesGenerator
as first argument
๐ Features
- โ Added
clap::ArgValue
to denote information about possible values for argsclap::ColorChoice
to specify color setting for the app
- โ Added Settings
AppSettings::AllowInvalidUtf8ForExternalSubcommands
AppSettings::Multicall
behindunstable-multicall
featureArgSettings::AllowInvalidUtf8
- โ Added Methods
- ArgEnum
ArgEnum::value_variants
ArgEnum::to_arg_value
- App
App::color
App::error
App::get_long_about
App::get_help_heading
- Arg
Arg::is_positional
- ๐ Allow positionals to occur multiple times
- ๐ Renamed Features