clap/CHANGELOG.md

122 lines
5.2 KiB
Markdown
Raw Normal View History

# v0.2.6 (2018-XX-XX)
* Fail compilation when using `default_value` or `required` with `bool` ([#80](https://github.com/TeXitoi/structopt/issues/80)) by [@TeXitoi](https://github.com/TeXitoi)
2018-03-29 22:13:30 +00:00
* Fix compilation with `#[deny(warnings)]` with the `!` type (https://github.com/rust-lang/rust/pull/49039#issuecomment-376398999) by [@TeXitoi](https://github.com/TeXitoi)
* Improve first example in the documentation ([#82](https://github.com/TeXitoi/structopt/issues/82)) by [@TeXitoi](https://github.com/TeXitoi)
2018-03-07 22:50:49 +00:00
# v0.2.5 (2018-03-07)
2018-03-07 22:50:49 +00:00
* Work around breakage when `proc-macro2`'s nightly feature is enabled. ([#77](https://github.com/Texitoi/structopt/pull/77) and [proc-macro2#67](https://github.com/alexcrichton/proc-macro2/issues/67)) by [@fitzgen](https://github.com/fitzgen)
2018-02-25 10:24:21 +00:00
# v0.2.4 (2018-02-25)
* Fix compilation with `#![deny(missig_docs]` ([#74](https://github.com/TeXitoi/structopt/issues/74)) by [@TeXitoi](https://github.com/TeXitoi)
2018-02-24 11:11:08 +00:00
* Fix [#76](https://github.com/TeXitoi/structopt/issues/76) by [@TeXitoi](https://github.com/TeXitoi)
2018-02-25 10:22:24 +00:00
* Re-licensed to Apache-2.0/MIT by [@CAD97](https://github.com/cad97)
# v0.2.3 (2018-02-16)
* An empty line in a doc comment will result in a double linefeed in the generated about/help call by [@TeXitoi](https://github.com/TeXitoi)
2018-02-12 22:46:15 +00:00
# v0.2.2 (2018-02-12)
* Fix [#66](https://github.com/TeXitoi/structopt/issues/66) by [@TeXitoi](https://github.com/TeXitoi)
2018-02-11 22:53:57 +00:00
# v0.2.1 (2018-02-11)
* Fix a bug around enum tuple and the about message in the global help by [@TeXitoi](https://github.com/TeXitoi)
2018-02-12 22:46:15 +00:00
* Fix [#65](https://github.com/TeXitoi/structopt/issues/65) by [@TeXitoi](https://github.com/TeXitoi)
# v0.2.0 (2018-02-10)
2018-01-31 22:14:33 +00:00
## Breaking changes
2018-02-03 16:05:36 +00:00
### Don't special case `u64` by [@SergioBenitez](https://github.com/SergioBenitez)
2018-02-03 14:31:51 +00:00
If you are using a `u64` in your struct to get the number of occurence of a flag, you should now add `parse(from_occurrences)` on the flag.
For example
```rust
#[structopt(short = "v", long = "verbose")]
verbose: u64,
```
must be changed by
```rust
#[structopt(short = "v", long = "verbose", parse(from_occurrences))]
verbose: u64,
```
2018-02-03 16:05:36 +00:00
This feature was surprising as shown in [#30](https://github.com/TeXitoi/structopt/issues/30). Using the `parse` feature seems much more natural.
2018-01-31 22:14:33 +00:00
2018-02-03 16:05:36 +00:00
### Change the signature of `Structopt::from_clap` to take its argument by reference by [@TeXitoi](https://github.com/TeXitoi)
2018-02-03 15:53:31 +00:00
There was no reason to take the argument by value. Most of the StructOpt users will not be impacted by this change. If you are using `StructOpt::from_clap`, just add a `&` before the argument.
2018-02-04 14:38:49 +00:00
### Fail if attributes are not used by [@TeXitoi](https://github.com/TeXitoi)
StructOpt was quite fuzzy in its attribute parsing: it was only searching for interresting things, e. g. something like `#[structopt(foo(bar))]` was accepted but not used. It now fails the compilation.
You should have nothing to do here. This breaking change may highlight some missuse that can be bugs.
In future versions, if there is cases that are not highlighed, they will be considerated as bugs, not breaking changes.
### Use `raw()` wrapping instead of `_raw` suffixing by [@TeXitoi](https://github.com/TeXitoi)
The syntax of raw attributes is changed to improve the syntax.
You have to change `foo_raw = "bar", baz_raw = "foo"` by `raw(foo = "bar", baz = "foo")` or `raw(foo = "bar"), raw(baz = "foo")`.
2018-02-03 15:53:31 +00:00
## New features
2018-02-03 16:05:36 +00:00
* Add `parse(from_occurrences)` parser by [@SergioBenitez](https://github.com/SergioBenitez)
* Support 1-uple enum variant as subcommand by [@TeXitoi](https://github.com/TeXitoi)
* structopt-derive crate is now an implementation detail, structopt reexport the custom derive macro by [@TeXitoi](https://github.com/TeXitoi)
2018-02-10 19:56:16 +00:00
* Add the `StructOpt::from_iter` method by [@Kerollmops](https://github.com/Kerollmops)
2018-02-03 15:53:31 +00:00
## Documentation
2018-01-31 22:14:33 +00:00
2018-02-03 16:05:36 +00:00
* Improve doc by [@bestouff](https://github.com/bestouff)
* All the documentation is now on the structopt crate by [@TeXitoi](https://github.com/TeXitoi)
2018-01-31 22:14:33 +00:00
# v0.1.7 (2018-01-23)
2018-02-03 16:05:36 +00:00
* Allow opting out of clap default features by [@ski-csis](https://github.com/ski-csis)
2018-01-31 22:14:33 +00:00
# v0.1.6 (2017-11-25)
2018-02-03 16:05:36 +00:00
* Improve documentation by [@TeXitoi](https://github.com/TeXitoi)
* Fix bug [#31](https://github.com/TeXitoi/structopt/issues/31) by [@TeXitoi](https://github.com/TeXitoi)
2018-01-31 22:14:33 +00:00
# v0.1.5 (2017-11-14)
2018-02-03 16:05:36 +00:00
* Fix a bug with optional subsubcommand and Enum by [@TeXitoi](https://github.com/TeXitoi)
2018-01-31 22:14:33 +00:00
# v0.1.4 (2017-11-09)
2018-02-03 16:05:36 +00:00
* Implement custom string parser from either `&str` or `&OsStr` by [@kennytm](https://github.com/kennytm)
2018-01-31 22:14:33 +00:00
# v0.1.3 (2017-11-01)
2018-02-03 16:05:36 +00:00
* Improve doc by [@TeXitoi](https://github.com/TeXitoi)
2018-01-31 22:14:33 +00:00
# v0.1.2 (2017-11-01)
2018-02-03 16:05:36 +00:00
* Fix bugs [#24](https://github.com/TeXitoi/structopt/issues/24) and [#25](https://github.com/TeXitoi/structopt/issues/25) by [@TeXitoi](https://github.com/TeXitoi)
* Support of methods with something else that a string as argument thanks to `_raw` suffix by [@Flakebi](https://github.com/Flakebi)
2018-01-31 22:14:33 +00:00
# v0.1.1 (2017-09-22)
2018-02-03 16:05:36 +00:00
* Better formating of multiple authors by [@killercup](https://github.com/killercup)
2018-01-31 22:14:33 +00:00
# v0.1.0 (2017-07-17)
2018-02-03 16:05:36 +00:00
* Subcommand support by [@williamyaoh](https://github.com/williamyaoh)
2018-01-31 22:14:33 +00:00
# v0.0.5 (2017-06-16)
2018-02-03 16:05:36 +00:00
* Using doc comment to populate help by [@killercup](https://github.com/killercup)
2018-01-31 22:14:33 +00:00
# v0.0.3 (2017-02-11)
2018-02-03 16:05:36 +00:00
* First version with flags, arguments and options support by [@TeXitoi](https://github.com/TeXitoi)