All Versions
187
Latest Version
Avg Release Cycle
59 days
Latest Release
121 days ago
Changelog History
Page 1
Changelog History
Page 1
-
v3.0.0-beta.2
September 18, 2020๐ฅ BREAKING CHANGES
- โ Removed
From<&yaml_rust::yaml::Hash>
forArgGroup
- App
App::write_version
in favor ofwrite!(w, App::render_version)
App::write_long_version
in favor ofwrite!(w, App::render_long_version)
- Error
Error::cause
in favor of<Error as Display>::to_string
- Macros
_clap_count_exprs!
- ๐ Renamed Methods
- App
App::set_term_width
=>App::term_width
- Arg
Arg::from_yaml
=>Arg::from
Arg::with_name
=>Arg::new
Arg::required_if
=>Arg::required_if_eq
Arg::required_ifs
=>Arg::required_if_eq_any
Arg::required_unless
=>Arg::required_unless_present
Arg::required_unless_one
=>Arg::required_unless_present_any
Arg::required_unless_all
=>Arg::required_unless_present_all
- ArgGroup
ArgGroup::from_yaml
=>ArgGroup::from
ArgGroup::with_name
=>ArgGroup::new
- ๐ Renamed Variants
- ErrorKind
ErrorKind::HelpDisplayed
=>ErrorKind::DisplayHelp
ErrorKind::VersionDisplayed
=>ErrorKind::DisplayVersion
- ๐ Changed
App::print_help
&App::print_long_help
now returnstd::io::Result
App::write_help
&App::write_long_help
now returnstd::io::Result
Error::info
now is of typeVec<String>
instead ofOption<Vec<String>>
ArgMatches::subcommand
now returnsOption<(&str, &ArgMatches)>
short
in#[clap()]
now acceptschar
instead of&str
๐ Features
- โ Added support for subcommands that are flags (pacman style)
- โ Added
Indices
that is returned byArgMatches::indices_of
- โ Added
@global_setting
for app's macro builder - โ Added Methods
- Arg
Arg::default_missing_value
Arg::default_missing_value_os
Arg::default_missing_values
Arg::default_missing_values_os
Arg::short_alias
Arg::short_aliases
Arg::visible_short_alias
Arg::visible_short_aliases
Arg::value_hint
Arg::validator_regex
(gated behindregex
feature)- App
App::subcommand_placeholder
App::before_long_help
App::after_long_help
- TODO: List App::get_* methods
โจ Enhancements
help_heading
defined onArg
now has higher priority thanApp
- 0๏ธโฃ Limited default text wrapping to 100 when
wrap_help
feature is not enabled - ๐ Multiple bug fixes and error message improvements
- ๐ Size and Performance improvements
- โ Removed
-
v3.0.0-beta.1
May 03, 2020Minimum Required Rust
- ๐ As of this release,
clap
requiresrustc 1.40.0
or greater.
๐ฅ BREAKING CHANGES
- โ Removed
SubCommand
in favor ofApp
SubCommand::with_name
=>App::new
SubCommand::from_yaml
=>App::from
- App
App::with_defaults
App::version_message
in favor ofApp::mut_arg
App::version_short
in favor ofApp::mut_arg
App::help_message
in favor ofApp::mut_arg
App::help_short
in favor ofApp::mut_arg
App::arg_from_usage
in favor ofApp::arg
App::args_from_usage
in favor ofApp::args(usage.lines().map(|l| l.trim()).filter(|l| !l.is_empty()))
App::gen_completions
in favor of TODO:App::gen_completions_to
in favor of TODO:App::settings
in favor ofApp::setting(Setting1 | Setting2)
App::unset_settings
in favor ofApp::unset_setting(Setting1 | Setting2)
App::global_settings
in favor ofApp::global_setting(Setting1 | Setting2)
- Arg
Arg::empty_values
in favor of TODO:- ArgMatches
ArgMatches::usage
in favor ofApp::generate_usage
- Macros
arg_enum!
in favor ofArgEnum
derive macro.value_t!
in favor ofArgMatches::value_of_t
value_t_or_exit!
in favor ofArgMatches::value_of_t_or_exit
values_t!
in favor ofArgMatches::values_of_t
values_t_or_exit!
in favor ofArgMatches::values_of_t_or_exit
- โ Removed Settings
AppSettings::PropagateGlobalValuesDown
ArgSettings::Global
in favor ofArg::global
methodArgSettings::Multiple
in favor ofArgSettings::MultipleValues
andArgSettings::MultipleOccurrences
- ๐ Renamed Methods
- App
App::from_yaml
=>App::from
App::arg_from_usage
=>App::arg
App::help
=>App::override_help
App::usage
=>App::override_usage
App::template
=>App::help_template
App::get_matches_safe
=>App::try_get_matches
App::get_matches_from_safe
=>App::try_get_matches_from
App::get_matches_from_safe_borrow
=>App::try_get_matches_from_mut
- Arg
Arg::help
=>Arg::about
Arg::from_usage
=>Arg::from
Arg::set
=>Arg::setting
Arg::unset
=>Arg::unset_setting
- ๐ Renamed Settings
ArgSettings::CaseInsensitive
=>ArgSettings::IgnoreCase
ArgSettings::AllowLeadingHyphen
=>ArgSettings::AllowHyphenValues
ArgSettings::EmptyValues
=>ArgSettings::AllowEmptyValues
- ๐ Renamed Fields
Error::message
=>Error::cause
- ๐ Changed
App::write_help
is now a mutable reference instance method (takes&mut self
)Arg::short
now acceptschar
instead of&str
Arg::validator
now takes first argument asFn(&str) -> Result<O, E: ToString>
instead ofFn(String) -> Result<(), String>
Arg::validator_os
now takes first argument asFn(&OsStr) -> Result<O, OsString>
instead ofFn(&OsStr) -> Result<(), OsString>
- โ Removed support for
{n}
in help text - ๐ In usage parser, for options
[name]... --option [val]
results inArgSettings::MultipleOccurrences
but--option [val]...
results inArgSettings::MultipleValues
andArgSettings::MultipleOccurrences
. Before both resulted in the same thing App
andArg
now need only one lifetime- ๐ Allowing empty values is no longer the default
- 0๏ธโฃ
UseValueDelimiter
is no longer the default App::override_usage
no longer implies\t
which allows multi lined usages
๐ Features
- โ Added Methods
- App
App::replace
App::get_matches_mut
App::mut_arg
App::unset_global_setting
App::help_heading
App::stop_custom_headings
- Arg
Arg::exclusive
Arg::multiple_values
Arg::multiple_occurrences
Arg::help_heading
- โ Added Settings
AppSettings::HelpRequired
AppSettings::NoAutoHelp
AppSettings::NoAutoVersion
ArgSettings::SubcommandPrecedenceOverArg
โจ Enhancements
- Made
App::arg
andApp::args
more generic - ๐ Improvements to
clap_app!
macro to make it support more wider use cases - ๐ Colors now work correctly on Windows Console
- ๐ Multiple bug fixes and error message improvements
- ๐ Improvements to parsing logic and help messages
- ๐ As of this release,
-
v2.33.3
August 14, 2020๐ Improvements
- ๐ Suppress deprecation warnings when using
crate_*
macros.
- ๐ Suppress deprecation warnings when using
-
v2.33.2
August 06, 2020v2.33.2 (2020-08-5)
๐ Documentation
- ๐ Fixed links to
2.x
examples. Now they point to the right place.
- ๐ Fixed links to
-
v2.33.1
May 11, 2020 -
v2.33.0
April 06, 2019๐ New Sponsor
- Stephen Oats is now a sponsor \o/ (823457c0)
- SPONSORS.md: fixes Josh Triplett's info in the sponsor document (24cb5740)
๐ Features
- Completions: adds completion support for Elvish. (e9d0562a)
- ๐ There is a new setting to disable automatic building of
--help
and-h
flags (AppSettings::DisableAutoHelp
)
๐ Improvements
- arg_matches.rs: add Debug implementations (47192b7a)
- macros: Support shorthand syntax for ArgGroups (df9095e7)
๐ Documentation
๐ Bug Fixes
- add debug assertion for missing args in subcommand ArgGroup (2699d9e5)
- โช Restore compat with Rust 1.21 (6b263de1)
- Don't mention unused subcommands (ef92e2b6)
- OsValues: Add
ExactSizeIterator
implementation (356c69e5) - arg_enum!:
- completions: improve correctness of completions when whitespace is involved (5a08ff29)
- help message: Unconditionally uses long description for subcommands (6acc8b6a, closes #897)
- macros: fixes broken pattern which prevented calling multi-argument Arg methods (9e7a352e)
- ๐ parser: Better interaction between AllowExternalSubcommands and SubcommandRequired (9601c95a)
Minimum Required Rust
- ๐ As of this release,
clap
requiresrustc 1.31.0
or greater.
-
v2.32.0
June 26, 2018Minimum Required Rust
- ๐ As of this release,
clap
requiresrustc 1.21.0
or greater.
๐ Features
- Completions: adds completion support for Elvish. (e9d0562a)
๐ Improvements
- macros: Support shorthand syntax for ArgGroups (df9095e7)
๐ Bug Fixes
- OsValues: Add
ExactSizeIterator
implementation (356c69e5) - arg_enum!: Invalid expansions of some trailing-comma patterns (7023184f)
- help message: Unconditionally uses long description for subcommands (6acc8b6a, closes #897)
๐ Documentation
- ๐ Refer to macOS rather than OSX. (ab0d767f)
- ๐ As of this release,
-
v2.31.2
March 19, 2018v2.31.2 (2018-03-19)
๐ Bug Fixes
- Fish Completions: fixes a bug that only allowed a single completion in in Fish Shell (e8774a8, closes #1212)
- ๐ AllowExternalSubcommands : fixes a bug where external subcommands would be blocked by a similarly named subcomand (suggestions were getting in the way). (a410e85)
๐ Documentation
- ๐ Fixes some typos in the
README.md
(c8e685d7)
v2.31.1 (2018-03-06)
๐ Improvements
- ๐ AllowMissingPositional: improves the ability of AllowMissingPositional to allow 'skipping' to the last positional arg with '--' (df20e6e2)
v2.31.0 (2018-03-04)
๐ Features
- Arg Indices: adds the ability to query argument value indices (f58d0576)
- Indices: implements an Indices<Item=&usize> iterator (1e67be44)
- Raw Args adds a convenience function to
Arg
that allows implying all ofArg::last
Arg::allow_hyphen_values
andArg::multiple(true)
(66a78f29)
๐ Documentation
- ๐ Fix some typos and markdown issues. (935ba0dd)
- Arg Indices: adds the documentation for the arg index querying methods (50bc0047)
- CONTRIBUTING.md: fix url to clippy upstream repo to point to https://github.com/rust-lang-nursery/rust-clippy instead of https://github.com/Manishearth/rust-clippy (42407d7f)
- Values: improves the docs example of the Values iterator (74075d65)
- โก๏ธ Updates readme to hint that the
wrap_help
feature is a thing (fc7ab227)
๐ Improvements
-
v2.31.0
March 04, 2018๐ Features
- Arg Indices: adds the ability to query argument value indices (f58d0576)
- Indices: implements an Indices iterator (1e67be44)
- Raw Args adds a convenience function to
Arg
that allows implying all ofArg::last
Arg::allow_hyphen_values
andArg::multiple(true)
(66a78f29)
๐ Documentation
- โ๏ธ Fix some typos and markdown issues. (935ba0dd)
- Arg Indices: adds the documentation for the arg index querying methods (50bc0047)
- CONTRIBUTING.md: fix url to clippy upstream repo to point to https://github.com/rust-lang-nursery/rust-clippy instead of https://github.com/Manishearth/rust-clippy (42407d7f)
- Values: improves the docs example of the Values iterator (74075d65)
- โก๏ธ Updates readme to hint that the
wrap_help
feature is a thing (fc7ab227)
๐ Improvements