clap/clap_derive/examples/README.md

79 lines
1.8 KiB
Markdown
Raw Normal View History

Ported all the commits from structopt (#23) * Automatic naming of fields and subcommands (#143) * Introduce smarter parsing of doc comments. (#146) * Fix invalid structopt syntax error message (#154) There was a typo preventing the probematic attr to be shown to the user. * Fix spelling: occurences -> occurrences, (#158) was found in comments and code, but required no user-facing API change. * Remove line-ending periods from short help. (#161) * Fix #168 * Support Option<Option<T>> field types (#190) * Support Option<Vec<T>> field type (#191) * Fix use of deprecated function * Fix some clippy lints * Update deprecated function and provide more info about the parsing error (#193) * Improve ChangeLog as suggested by @ErichDonGubler (#194) * [Casing] Change default from verbatim to kebab. (#204) .. fixes TeXitoi/structopt#202 * Use trybuild for testing expected proc macro errors (#205) * Custom attributes parser (#198) * update README.md for 0.3 fix #208 * Small fixes: clippy and typos (#215) * Add example for environment variables (#160) (#216) * Support skipping struct fields (#213) * Now error messages highlight the error location (#225) * Minor fixes * Change behavior of `about/author/version` and ad `no_version` * Emit error about `raw` removal * Update changelog * Update keyvalue example (#234) * Update documentation and changelog (#236) * Update dependencies (#227) * Bump minimum rustc version to 1.36 * Fix issues * Fix structopt-derive permissions (#239) * Fix #245 (#246) * Emit dummy impls on error (#248) * Fix changelog example (#250) * Do not call .verison() when CARGO_PKG_VERSION is not set * Update and improve docs * Propagate span info from origin code to generated code Most of `quote!` invocations are replaced with `quote_spanned!` ones. Now everywhere - sometimes it's pointless, sometimes we don't have any meaningless location to toke a span from, sometimes I just can't workaround the current implementation - too much changes. * Fix nightly tests * Do not mangle `author` string inside `<...>` * Support `skip = value` syntax * Fix code formatting * Fix nightly tests * Run ui tests only on stable * Add from_flag parser (#271) * Clarify docs and error messages (#277) * Fix parse for OptionVec (#279) ref pull #191 * Fix #269 and #265 (#278) * Pass the try_from_str functions a &str instead of a &String. (#282) In most cases this doesn't matter, as &String is coerced to a &str, but this fails for generic functions like CString::new. * Add an example of a negative flag (i.e. --no-verbose) Question from https://github.com/TeXitoi/structopt/issues/280 * Fix #283 (#284) Fix #283 * Add `examples/README.md` and do some cleanup * Handle special types correctly * cargo clippy * Handle inter-expansion top-level args properly * Cleanup tests * Update proc-macro-error to v0.4 * Offer helpful suggestion on `raw(...)` error * Add `after_help` example * Prohibit positional `bool` args * Add tests/utils.rs * fixed typo, removed misleading doc * Remove CHANGELOG additions * Rust 2018 * Addressed review Co-authored-by: rnd <bruno.kirschner@online.de> Co-authored-by: Robin Lambertz <github@roblab.la> Co-authored-by: florianjacob <accounts+github@florianjacob.de> Co-authored-by: Ted Driggs <ted.driggs@outlook.com> Co-authored-by: Guillaume P. <TeXitoi@users.noreply.github.com> Co-authored-by: Ivan Veselov <veselov@gmail.com> Co-authored-by: Owen Walpole <owenthewizard@hotmail.com> Co-authored-by: Robin Stocker <robin.stocker@gmail.com> Co-authored-by: CreepySkeleton <creepy-skeleton@yandex.ru> Co-authored-by: Ophir LOJKINE <ophir.lojkine@auto-grid.com> Co-authored-by: kpcyrd <git@rxv.cc> Co-authored-by: Luiz F. A. de Prá <luizdepra@users.noreply.github.com> Co-authored-by: Andy Weiss <wvvwwvw@gmail.com> Co-authored-by: xiaoniu-578fa6bff964d005 <32661032+xiaoniu-578fa6bff964d005@users.noreply.github.com> Co-authored-by: Mara Bos <m-ou.se@m-ou.se> Co-authored-by: Renê Couto e Silva <31329678+csrene@users.noreply.github.com>
2020-01-07 10:17:23 +00:00
# Collection of examples "how to use `clap_derive`"
### [Help on the bottom](after_help.rs)
How to append a postscript to the help message generated.
### [At least N](at_least_two.rs)
How to require presence of at least N values, like `val1 val2 ... valN ... valM`.
### [Basic](basic.rs)
A basic example how to use `clap_derive`.
### [Deny missing docs](deny_missing_docs.rs)
**This is not an example but a test**, it should be moved to `tests` folder
as soon as [this](https://github.com/rust-lang/rust/issues/24584) is fixed (if ever).
### [Doc comments](doc_comments.rs)
How to use doc comments in place of `help/long_help`.
### [Enums as arguments](enum_in_args.rs)
How to use `arg_enum!` with `clap_derive`.
### [Arguments of subcommands in separate `struct`](enum_tuple.rs)
How to extract subcommands' args into external structs.
### [Environment variables](env.rs)
How to use environment variable fallback an how it interacts with `default_value`.
### [Advanced](example.rs)
Somewhat complex example of usage of `clap_derive`.
### [Flatten](flatten.rs)
How to use `#[clap(flatten)]`
### [Git](git.rs)
Pseudo-`git` example, shows how to use subcommands and how to document them.
### [Groups](group.rs)
Using `clap::Arg::group` with `clap`.
### [`key=value` pairs](keyvalue.rs)
How to parse `key=value` pairs.
### [`--no-*` flags](negative_flag.rs)
How to add `no-thing` flag which is `true` by default and `false` if passed.
### [Rename all](rename_all.rs)
How `#[clap(rename_all)]` works.
### [Skip](skip.rs)
How to use `#[clap(skip)]`.
### [Aliases](subcommand_aliases.rs)
How to use aliases
### [`true` or `false`](true_or_false.rs)
How to express "`"true"` or `"false"` argument.
2020-02-05 11:12:39 +00:00
### [Author, description, and version from `Cargo.toml`](from_crate.rs)
//! How to derive a author, description, and version from Cargo.toml