Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-11-10 06:44:16 +00:00
Code Issues Projects Releases Packages Wiki Activity

chore: Release

Browse source
This commit is contained in:
Ed Page 2022-04-01 09:15:32 -05:00
parent 6aa40ad2cb
commit 08f74046dc
4 changed files with 22 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
CHANGELOG.md
View file

@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
<!-- next-header -->
## [Unreleased] - ReleaseDate
## [3.1.8] - 2022-04-01
### Fixes
- Add `Debug` impls to more types
@ -3245,7 +3247,8 @@ Minimum version of Rust is now v1.13.0 (Stable)
* **arg** allow lifetimes other than 'static in arguments ([9e8c1fb9](https://github.com/clap-rs/clap/commit/9e8c1fb9406f8448873ca58bab07fe905f1551e5))
<!-- next-url -->
[Unreleased]: https://github.com/clap-rs/clap/compare/v3.1.7...HEAD
[Unreleased]: https://github.com/clap-rs/clap/compare/v3.1.8...HEAD
[3.1.8]: https://github.com/clap-rs/clap/compare/v3.1.7...v3.1.8
[3.1.7]: https://github.com/clap-rs/clap/compare/v3.1.6...v3.1.7
[3.1.6]: https://github.com/clap-rs/clap/compare/v3.1.5...v3.1.6
[3.1.5]: https://github.com/clap-rs/clap/compare/v3.1.4...v3.1.5

2
Cargo.toml
View file

@ -8,7 +8,7 @@ members = [
[package]
name = "clap"
version = "3.1.7"
version = "3.1.8"
description = "A simple to use, efficient, and full-featured Command Line Argument Parser"
repository = "https://github.com/clap-rs/clap"
documentation = "https://docs.rs/clap/"

26
README.md
View file

@ -5,8 +5,8 @@
[![Crates.io](https://img.shields.io/crates/v/clap?style=flat-square)](https://crates.io/crates/clap)
[![Crates.io](https://img.shields.io/crates/d/clap?style=flat-square)](https://crates.io/crates/clap)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](https://github.com/clap-rs/clap/blob/v3.1.7/LICENSE-APACHE)
[![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](https://github.com/clap-rs/clap/blob/v3.1.7/LICENSE-MIT)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](https://github.com/clap-rs/clap/blob/v3.1.8/LICENSE-APACHE)
[![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](https://github.com/clap-rs/clap/blob/v3.1.8/LICENSE-MIT)
[![Build Status](https://img.shields.io/github/workflow/status/clap-rs/clap/CI/staging?style=flat-square)](https://github.com/clap-rs/clap/actions/workflows/ci.yml?query=branch%3Astaging)
[![Coverage Status](https://img.shields.io/coveralls/github/clap-rs/clap/master?style=flat-square)](https://coveralls.io/github/clap-rs/clap?branch=master)
[![Contributors](https://img.shields.io/github/contributors/clap-rs/clap?style=flat-square)](https://github.com/clap-rs/clap/graphs/contributors)
@ -14,15 +14,15 @@
Dual-licensed under [Apache 2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT).
1. [About](#about)
2. Tutorial: [Builder API](https://github.com/clap-rs/clap/blob/v3.1.7/examples/tutorial_builder/README.md), [Derive API](https://github.com/clap-rs/clap/blob/v3.1.7/examples/tutorial_derive/README.md)
3. [Examples](https://github.com/clap-rs/clap/blob/v3.1.7/examples/README.md)
2. Tutorial: [Builder API](https://github.com/clap-rs/clap/blob/v3.1.8/examples/tutorial_builder/README.md), [Derive API](https://github.com/clap-rs/clap/blob/v3.1.8/examples/tutorial_derive/README.md)
3. [Examples](https://github.com/clap-rs/clap/blob/v3.1.8/examples/README.md)
4. [API Reference](https://docs.rs/clap)
- [Derive Reference](https://github.com/clap-rs/clap/blob/v3.1.7/examples/derive_ref/README.md)
- [Derive Reference](https://github.com/clap-rs/clap/blob/v3.1.8/examples/derive_ref/README.md)
- [Feature Flags](#feature-flags)
5. [CHANGELOG](https://github.com/clap-rs/clap/blob/v3.1.7/CHANGELOG.md)
6. [FAQ](https://github.com/clap-rs/clap/blob/v3.1.7/docs/FAQ.md)
5. [CHANGELOG](https://github.com/clap-rs/clap/blob/v3.1.8/CHANGELOG.md)
6. [FAQ](https://github.com/clap-rs/clap/blob/v3.1.8/docs/FAQ.md)
7. [Questions & Discussions](https://github.com/clap-rs/clap/discussions)
8. [Contributing](https://github.com/clap-rs/clap/blob/v3.1.7/CONTRIBUTING.md)
8. [Contributing](https://github.com/clap-rs/clap/blob/v3.1.8/CONTRIBUTING.md)
8. [Sponsors](#sponsors)
## About
@ -32,8 +32,8 @@ Create your command-line parser, with all of the bells and whistles, declarative
### Example
This uses our
[Derive API](https://github.com/clap-rs/clap/blob/v3.1.7/examples/tutorial_derive/README.md)
which provides access to the [Builder API](https://github.com/clap-rs/clap/blob/v3.1.7/examples/tutorial_builder/README.md) as attributes on a `struct`:
[Derive API](https://github.com/clap-rs/clap/blob/v3.1.8/examples/tutorial_derive/README.md)
which provides access to the [Builder API](https://github.com/clap-rs/clap/blob/v3.1.8/examples/tutorial_builder/README.md) as attributes on a `struct`:
<!-- Copied from examples/demo.{rs,md} -->
```rust,no_run
@ -63,7 +63,7 @@ fn main() {
Add this to `Cargo.toml`:
```toml
[dependencies]
clap = { version = "3.1.7", features = ["derive"] }
clap = { version = "3.1.8", features = ["derive"] }
```
```bash
$ demo --help
@ -103,12 +103,12 @@ CLI parsers optimized for other use cases.
### Selecting an API
Why use the declarative [Derive API](https://github.com/clap-rs/clap/blob/v3.1.7/examples/tutorial_derive/README.md):
Why use the declarative [Derive API](https://github.com/clap-rs/clap/blob/v3.1.8/examples/tutorial_derive/README.md):
- Easier to read, write, and modify
- Easier to keep the argument declaration and reading of argument in sync
- Easier to reuse, e.g. [clap-verbosity-flag](https://crates.io/crates/clap-verbosity-flag)
Why use the procedural [Builder API](https://github.com/clap-rs/clap/blob/v3.1.7/examples/tutorial_builder/README.md):
Why use the procedural [Builder API](https://github.com/clap-rs/clap/blob/v3.1.8/examples/tutorial_builder/README.md):
- Faster compile times if you aren't already using other procedural macros
- More flexible, e.g. you can look up how many times an argument showed up,
what its values were, and what were the indexes of those values. The Derive

8
src/derive.rs
View file

@ -20,7 +20,7 @@ use std::ffi::OsString;
/// See also [`Subcommand`] and [`Args`].
///
/// See the
/// [derive reference](https://github.com/clap-rs/clap/blob/v3.1.7/examples/derive_ref/README.md)
/// [derive reference](https://github.com/clap-rs/clap/blob/v3.1.8/examples/derive_ref/README.md)
/// for attributes and best practices.
///
/// **NOTE:** Deriving requires the `derive` feature flag
@ -306,7 +306,7 @@ pub trait FromArgMatches: Sized {
/// - `Variant(ChildArgs)`: No attribute is used with enum variants that impl `Args`.
///
/// See the
/// [derive reference](https://github.com/clap-rs/clap/blob/v3.1.7/examples/derive_ref/README.md)
/// [derive reference](https://github.com/clap-rs/clap/blob/v3.1.8/examples/derive_ref/README.md)
/// for attributes and best practices.
///
/// **NOTE:** Deriving requires the `derive` feature flag
@ -350,7 +350,7 @@ pub trait Args: FromArgMatches + Sized {
/// `Subcommand`.
///
/// See the
/// [derive reference](https://github.com/clap-rs/clap/blob/v3.1.7/examples/derive_ref/README.md)
/// [derive reference](https://github.com/clap-rs/clap/blob/v3.1.8/examples/derive_ref/README.md)
/// for attributes and best practices.
///
/// **NOTE:** Deriving requires the `derive` feature flag
@ -394,7 +394,7 @@ pub trait Subcommand: FromArgMatches + Sized {
/// - Allowing using the `#[clap(default_value_t)]` attribute without implementing `Display`.
///
/// See the
/// [derive reference](https://github.com/clap-rs/clap/blob/v3.1.7/examples/derive_ref/README.md)
/// [derive reference](https://github.com/clap-rs/clap/blob/v3.1.8/examples/derive_ref/README.md)
/// for attributes and best practices.
///
/// **NOTE:** Deriving requires the `derive` feature flag