clap-rs changelog and releases

All Versions

187

Latest Version

3.0.0-beta.2

Avg Release Cycle

59 days

Latest Release

121 days ago

Changelog History

Page 1

v3.0.0-beta.2
September 18, 2020
💥 BREAKING CHANGES
- ✂ Removed
  - From<&yaml_rust::yaml::Hash> for ArgGroup
  - App
  - App::write_version in favor of write!(w, App::render_version)
  - App::write_long_version in favor of write!(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 return std::io::Result
  - App::write_help & App::write_long_help now return std::io::Result
  - Error::info now is of type Vec<String> instead of Option<Vec<String>>
  - ArgMatches::subcommand now returns Option<(&str, &ArgMatches)>
  - short in #[clap()] now accepts char instead of &str
🔋 Features
- ➕ Added support for subcommands that are flags (pacman style)
- ➕ Added Indices that is returned by ArgMatches::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 behind regex feature)
  - App
  - App::subcommand_placeholder
  - App::before_long_help
  - App::after_long_help
- TODO: List App::get_* methods
✨ Enhancements
- help_heading defined on Arg now has higher priority than App
- 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
v3.0.0-beta.1
May 03, 2020
Minimum Required Rust
- 🚀 As of this release, clap requires rustc 1.40.0 or greater.
💥 BREAKING CHANGES
- ✂ Removed
  - SubCommand in favor of App
  - SubCommand::with_name => App::new
  - SubCommand::from_yaml => App::from
  - App
  - App::with_defaults
  - App::version_message in favor of App::mut_arg
  - App::version_short in favor of App::mut_arg
  - App::help_message in favor of App::mut_arg
  - App::help_short in favor of App::mut_arg
  - App::arg_from_usage in favor of App::arg
  - App::args_from_usage in favor of App::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 of App::setting(Setting1 | Setting2)
  - App::unset_settings in favor of App::unset_setting(Setting1 | Setting2)
  - App::global_settings in favor of App::global_setting(Setting1 | Setting2)
  - Arg
  - Arg::empty_values in favor of TODO:
  - ArgMatches
  - ArgMatches::usage in favor of App::generate_usage
  - Macros
  - arg_enum! in favor of ArgEnum derive macro.
  - value_t! in favor of ArgMatches::value_of_t
  - value_t_or_exit! in favor of ArgMatches::value_of_t_or_exit
  - values_t! in favor of ArgMatches::values_of_t
  - values_t_or_exit! in favor of ArgMatches::values_of_t_or_exit
- ✂ Removed Settings
  - AppSettings::PropagateGlobalValuesDown
  - ArgSettings::Global in favor of Arg::global method
  - ArgSettings::Multiple in favor of ArgSettings::MultipleValues and ArgSettings::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 accepts char instead of &str
  - Arg::validator now takes first argument as Fn(&str) -> Result<O, E: ToString> instead of Fn(String) -> Result<(), String>
  - Arg::validator_os now takes first argument as Fn(&OsStr) -> Result<O, OsString> instead of Fn(&OsStr) -> Result<(), OsString>
- ✂ Removed support for {n} in help text
- 📜 In usage parser, for options [name]... --option [val] results in ArgSettings::MultipleOccurrences but --option [val]... results in ArgSettings::MultipleValues and ArgSettings::MultipleOccurrences. Before both resulted in the same thing
- App and Arg 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 and App::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
v2.33.3
August 14, 2020
👌 Improvements
- 🗄 Suppress deprecation warnings when using crate_* macros.
v2.33.2
August 06, 2020
v2.33.2 (2020-08-5)

📚 Documentation
- 🛠 Fixed links to 2.x examples. Now they point to the right place.
v2.33.1
May 11, 2020
v2.33.1 (2020-05-11)

🐛 Bug Fixes
- 🏁 Windows: Prevent some panics when parsing invalid Unicode on Windows (922c645, closes #1905)
📚 Documentation
- 🛠 fixes versions referenced in the README (d307466a)
- README.md:
  - cuts down the number of examples to reduce confusion (6e508ee0)
👌 Improvements
- Deps: doesnt compile ansi_term on Windows since its not used (b57ee946, closes #1155)
Minimum Required Rust
- 🚀 As of this release, clap requires rustc 1.36.0 or greater.
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
- 🍎 Refer to macOS rather than OSX. (ab0d767f)
- README.md: use https for all links (96a7639a)
🐛 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!:
  - Fix comma position for valid values. (1f1f9ff3)
  - Invalid expansions of some trailing-comma patterns (7023184f)
- 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 requires rustc 1.31.0 or greater.
v2.32.0
June 26, 2018
Minimum Required Rust
- 🚀 As of this release, clap requires rustc 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)
v2.31.2
March 19, 2018
v2.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 of Arg::last Arg::allow_hyphen_values and Arg::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
- 🚀 Cargo.toml: use codegen-units = 1 in release and bench profiles (19f425ea)
- ➕ Adds WASM support (clap now compiles on WASM!) (689949e5)
- 👉 Uses the short help tool-tip for PowerShell completion scripts (ecda22ce)
v2.31.1
March 06, 2018
👌 Improvements
- 👍 AllowMissingPositional: improves the ability of AllowMissingPositional to allow 'skipping' to the last positional arg with '--' (df20e6e2)
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 of Arg::last Arg::allow_hyphen_values and Arg::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
- 🚀 Cargo.toml: use codegen-units = 1 in release and bench profiles (19f425ea)
- 👍 Adds WASM support (clap now compiles on WASM!) (689949e5)
- Uses the short help tool-tip for PowerShell completion scripts (ecda22ce)

1
2
3
4
5
Next ›
Last »

clap-rs changelog

a simple to use, full featured command-line argument parser

Changelog History Page 1

💥 BREAKING CHANGES

🔋 Features

✨ Enhancements

Minimum Required Rust

💥 BREAKING CHANGES

🔋 Features

✨ Enhancements

👌 Improvements

v2.33.2 (2020-08-5)

📚 Documentation

v2.33.1 (2020-05-11)

🐛 Bug Fixes

📚 Documentation

👌 Improvements

Minimum Required Rust

🆕 New Sponsor

🔋 Features

👌 Improvements

📚 Documentation

🐛 Bug Fixes

Minimum Required Rust

Minimum Required Rust

🔋 Features

👌 Improvements

🐛 Bug Fixes

📚 Documentation

v2.31.2 (2018-03-19)

🐛 Bug Fixes

📚 Documentation

v2.31.1 (2018-03-06)

👌 Improvements

v2.31.0 (2018-03-04)

🔋 Features

📚 Documentation

👌 Improvements

👌 Improvements

🔋 Features

📚 Documentation

👌 Improvements

Changelog History

Page 1