mirror of
https://github.com/clap-rs/clap
synced 2024-12-12 13:52:34 +00:00
chore: increase version
This commit is contained in:
parent
3359683380
commit
37bfffc375
5 changed files with 39 additions and 18 deletions
30
CHANGELOG.md
30
CHANGELOG.md
|
@ -1,3 +1,33 @@
|
|||
<a name="v1.5.0"></a>
|
||||
## v1.5.0 (2015-11-13)
|
||||
|
||||
|
||||
#### Bug Fixes
|
||||
|
||||
* fixes a bug with required positional args in usage strings ([c6858f78](https://github.com/kbknapp/clap-rs/commit/c6858f78755f8e860204323c828c8355a066dc83))
|
||||
|
||||
#### Documentation
|
||||
|
||||
* **FAQ:** updates readme with slight changes to FAQ ([a4ef0fab](https://github.com/kbknapp/clap-rs/commit/a4ef0fab73c8dc68f1b138965d1340459c113398))
|
||||
|
||||
#### Improvements
|
||||
|
||||
* massive errors overhaul ([cdc29175](https://github.com/kbknapp/clap-rs/commit/cdc29175bc9c53e5b4aec86cbc04c1743154dae6))
|
||||
* **ArgMatcher:** huge refactor and deduplication of code ([8988853f](https://github.com/kbknapp/clap-rs/commit/8988853fb8825e8f841fde349834cc12cdbad081))
|
||||
* **Errors:** errors have been vastly improved ([e59bc0c1](https://github.com/kbknapp/clap-rs/commit/e59bc0c16046db156a88ba71a037db05028e995c))
|
||||
* **Traits:** refactoring some configuration into traits ([5800cdec](https://github.com/kbknapp/clap-rs/commit/5800cdec6dce3def4242b9f7bd136308afb19685))
|
||||
|
||||
#### Performance
|
||||
|
||||
* **App:**
|
||||
* more BTreeMap->Vec, Opts and SubCmds ([bc4495b3](https://github.com/kbknapp/clap-rs/commit/bc4495b32ec752b6c4b29719e831c043ef2a26ce))
|
||||
* changes flags BTreeMap->Vec ([d357640f](https://github.com/kbknapp/clap-rs/commit/d357640fab55e5964fe83efc3c771e53aa3222fd))
|
||||
* removed unneeded BTreeMap ([78971fd6](https://github.com/kbknapp/clap-rs/commit/78971fd68d7dc5c8e6811b4520cdc54e4188f733))
|
||||
* changes BTreeMap to VecMap in some instances ([64b921d0](https://github.com/kbknapp/clap-rs/commit/64b921d087fdd03775c95ba0bcf65d3f5d36f812))
|
||||
* removed excess clones ([ec0089d4](https://github.com/kbknapp/clap-rs/commit/ec0089d42ed715d293fb668d3a90b0db0aa3ec39))
|
||||
|
||||
|
||||
|
||||
<a name="v1.4.7"></a>
|
||||
### v1.4.7 (2015-11-03)
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
[package]
|
||||
|
||||
name = "clap"
|
||||
version = "1.4.7"
|
||||
version = "1.5.0"
|
||||
authors = ["Kevin K. <kbknapp@gmail.com>"]
|
||||
exclude = ["examples/*", "clap-tests/*", "tests/*", "benches/*", "*.png", "clap-perf/*"]
|
||||
description = "A simple to use, efficient, and full featured Command Line Argument Parser"
|
||||
|
|
25
README.md
25
README.md
|
@ -33,22 +33,13 @@ Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)
|
|||
|
||||
## What's New
|
||||
|
||||
If you're already familiar with `clap` but just want to see some new highlights as of **1.4.6**
|
||||
If you're already familiar with `clap` but just want to see some new highlights as of **1.5**
|
||||
|
||||
* **Major Bug Fixes in 1.4.6** We recommend everyone upgrade as soon as possible. See the [the changelog](https://github.com/kbknapp/clap-rs/blob/master/CHANGELOG.md) for details.
|
||||
* Using `get_matches_safe_*` family of methods no longer exits the process when help or version is displayed, instead it returns an `ClapError` with an `error_type` field set to `ClapErrorType::HelpDisplayed` or `ClapErrorType::VersionDisplayed` respectively. You must then call `ClapError::exit` or `std::process::exit` giving you the control.
|
||||
* Allows parsing without a binary name preceding (useful for daemon modes and interactive CLIs)
|
||||
* `-Lvalue` style options are **now supported**! (i.e. `-L` is the short, and `value` is the value being passed. Equivalent to `-L value`). This can be combined with flag expansion. Example: `-lF2` could be parsed as `-l -F 2` where `-l` is a flag and `-F` is an option that takes a number.
|
||||
* There is a **new opt-in setting** (`AppSettings::TrailingVarArg`) to allow the final positional argument to be a vararg and have `clap` not interpret the remaining arguments (i.e. useful when final argument should be a list of arguments for another command or process)
|
||||
* You can now access values from an argument in a group via the group name, instead of having to check each arg name individually to find out which one was used. The same applies for checking if an arg from a group `is_present()`
|
||||
* You now have the option to **not** `panic!` on invalid unicode. The `*_safe()` family of `get_matches` will return an `Err` with `ClapErrorType::InvalidUnicode`.
|
||||
* You have the option to get lossy unicode values. By using the `*_lossy()` versions of the `get_matches` family of methods all invalid unicode will be replaced with `U+FFFD` and **not** `panic!` or fail parsing.
|
||||
* Some documentation improvements
|
||||
* A new macro has been designed by [james-darkfox](https://github.com/james-darkfox) to give the simplicity of `from_usage` methods, but the performance of the Builder Pattern. Huge thanks to him! Fair warning this is very new, and may still have some kinks and tweaks left as we experiment ;)
|
||||
* Users can now print the help message programmatically using `App::write_help(io::Write)` and `App::print_help()`.
|
||||
* Users can now simply print the error message to `stderr` and exit gracefully programmatically using `ClapError::exit()`
|
||||
* You can now get argument matches **without** consuming your `App` struct using `App::get_matches_from_safe_borrow()`
|
||||
* Some other minor bug fixes and improvements
|
||||
* **huge performance boost** - parsing speed is literally half of what it used to be (and it was already fast). The following graph shows parsing speed, **to include** building the parser of valid arguments for a complex scenario with many arguments, relationships, and other restictions was parsed in ~10,000ns (~0.01 miliseconds)
|
||||
!(clap Performance Graph)[https://github.com/kbknapp/clap-rs/blob/master/clap-perf/clap_perf.png]
|
||||
* major refactor of code to de-dupilicate and reduce errors. This is a massive improvement and should make contributing to this project much easier.
|
||||
* massive errors overhaul thanks in part to the excellent read on [Error Handling](https://doc.rust-lang.org/book/error-handling.html) by [BurntSushi](https://github.com/burntsushi)
|
||||
* other minor bug fixes and improvements
|
||||
|
||||
For full details, see [CHANGELOG.md](https://github.com/kbknapp/clap-rs/blob/master/CHANGELOG.md)
|
||||
|
||||
|
@ -515,12 +506,12 @@ The following is a list of optional `clap` features:
|
|||
|
||||
### Dependencies Tree
|
||||
|
||||
The following graphic depicts `clap`s dependency graph.
|
||||
The following graphic depicts `clap`s dependency graph (generated using [cargo-grpah](https://github.com/kbknapp/cargo-graph)).
|
||||
|
||||
* **Dashed** Line: Optional dependency
|
||||
* **Red** Color: **NOT** included by default (must use cargo `features` to enable)
|
||||
|
||||
![clap dependencies](clap.png)
|
||||
![clap dependencies](clap_dep_graph.png)
|
||||
|
||||
### More Information
|
||||
|
||||
|
|
BIN
clap.png
BIN
clap.png
Binary file not shown.
Before Width: | Height: | Size: 18 KiB |
BIN
clap_dep_graph.png
Normal file
BIN
clap_dep_graph.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 33 KiB |
Loading…
Reference in a new issue