Commit graph

4398 commits

Author SHA1 Message Date
Ed Page
da03c2706c chore(ci): Run build/test all crates 2021-11-23 16:10:32 -06:00
Ed Page
6b5e7e28df chore(ci): Test benchmarks 2021-11-23 16:09:31 -06:00
Mooneyhan
8bc8967498 corrected minor grammar mistakes in README.md (clap-rs/clap#3033) 2021-11-23 13:25:47 -06:00
Ed Page
0fccd07001
Merge pull request #21 from epage/trycmd
test: More thoroughly test examples
2021-11-23 13:24:22 -06:00
Ed Page
bfa02fd418 test: More thoroughly test examples
This ports our example testing over to [trycmd](https://docs.rs/) so
we can:
- More thoroughly test our examples
- Provide always-up-to-date example usage

The old way of testing automatically picked up examples.  This new way
requires we have a `.md` file that uses the example in some way.

Notes:
- Moved overall example description to the `.md` file
- I added cross-linking between related examples
- `14_groups` had a redundant paragraph (twice talked about "one and
  only one"
2021-11-23 13:13:41 -06:00
Ed Page
d8b12a6bb5
Merge pull request #20 from epage/macro
Deprecate YAML and Usage Parser
2021-11-23 12:09:51 -06:00
Ed Page
d4173bd596 docs: Clean up deprecations 2021-11-23 10:32:05 -06:00
Ed Page
3c3a0b71d1 fix: Deprecate runtime usage parser
Fixes #8
2021-11-23 09:53:04 -06:00
Ed Page
4c4a2b86a0 refactor: Port over to arg! 2021-11-23 09:37:14 -06:00
Ed Page
263fe30568 feat: Usage parser macro
This is intended to replace the runtime usage parser and is not meant to
be a complete API in of itself, like `clap_app!`.  What is in scope is
everything that visually makes sense as in a usage string (see
[docopt](http://docopt.org/) for inspiration).  General setting of
attributes is out of scope.

This deviates from both `clap_app` and the runtime usage parser
- `clap_app` supported multiple values but has a bug because we made
  `Arg::value_name` non-appending, so we aren't supporting this yet
- We do not yet support optional flags that take a value
- In both, `...` is multiple occurrences and values while its only
  multiple occurrences for us
- We explicitly support optional values for flags
- Unlike `clap_app`, our name is optional
- Unlike runtime usage parser, our name syntax is simpler
- Unlike runtime usage parser, our name syntax does not allow modifiers

Its more limited than I would like.  Hopefully some people better with
macros can expand the feature set and turn more runtime errors into
compile-time errors.

This is to prepare for deprecating the runtime usage parser (#8).
2021-11-22 16:21:09 -06:00
Ed Page
136c8e229d fix: Arg::default has correct display order 2021-11-22 16:17:46 -06:00
Ed Page
fb917072f5 feat: name API 2021-11-22 16:17:46 -06:00
Ed Page
d159a3c2a4 docs: Clarify macro deprecation 2021-11-22 16:17:46 -06:00
Ed Page
19cd5ae9f0 docs: Update deprecation refrence 2021-11-22 16:17:46 -06:00
Ed Page
7604b1ed4a revert(usage): Go back to clap2 behavior 2021-11-22 16:17:46 -06:00
Ed Page
77b1adc950 Revert "fix(usage)!: Separate mutli-occ from multi-val syntax"
This reverts commit 53bd42a809.
2021-11-22 16:17:46 -06:00
Ed Page
7ac79da34a docs: Update clap_app docs 2021-11-22 16:17:46 -06:00
Ed Page
6ce9714e2b fix: Deprecate YAML API
Fixes #9
2021-11-22 16:17:46 -06:00
Ed Page
88fff13e71 Revert rename of from_yaml / from_usage
Since usage parser and yaml are on the way to being deprecated (#8, #9),
doing a rename also seems excessive, so rolling it back.

Past relevant PRs:
- clap-rs/clap#1157
- clap-rs/clap#1257
2021-11-22 16:17:46 -06:00
Ed Page
20101a5785
Merge pull request #19 from epage/benches
test: Get benches passing
2021-11-22 16:15:55 -06:00
Ed Page
4c7d29f464 test: Get benches passing 2021-11-22 16:09:39 -06:00
Marcin Puc
b95ced6fb3 Fix docs for Arg aliases (clap-rs/clap#3044) 2021-11-22 08:58:39 -06:00
Ed Page
700efb170a
Merge pull request #17 from epage/revert
Revert "Deprecate Arg::help in favour of Arg::about"
2021-11-18 12:42:01 -06:00
Ed Page
7e899cd340 Revert "Deprecate Arg::help in favour of Arg::about"
This reverts commits 24cb8b1..d0abb37 from clap-rs/clap#1840

This is part of #16.  clap-rs/clap#1840 wasn't the right call but we
don't have time to make the decision now, so instead of having one
option and changing it in 4.0, this reverts back to clap2 behavior.
2021-11-18 12:25:49 -06:00
Ed Page
154a88dafd
Merge pull request #18 from epage/check
chore(ci): Remove smoke build
2021-11-18 12:12:18 -06:00
Ed Page
b7d9787c5e chore(ci): Remove smoke build
When CI is ridiculously long, this helps cut it off early.  In our case,
this ends up being a large percentage of our CI time.
2021-11-18 12:00:24 -06:00
Ed Page
daf76bcd63 refactor(ci): Offer more flexibility 2021-11-18 11:52:09 -06:00
Ed Page
cd3837dccb
Merge pull request #13 from epage/examples
Fix problems found when testing examples
2021-11-17 21:19:29 -06:00
Ed Page
2d41f7409e
Merge pull request #12 from epage/doctest
test: Compile example in README
2021-11-17 21:11:48 -06:00
Ed Page
ff476660ce test: Compile example in README 2021-11-17 21:01:56 -06:00
Ed Page
11537b24a5
Merge pull request #7 from epage/revert
revert: Default value behaviour with conflicts and requirement validation
2021-11-17 15:56:27 -06:00
Ed Page
ede8af1da9
Merge pull request #5 from epage/dependabot/cargo/os_str_bytes-5.0
chore(deps): Update os_str_bytes requirement from 4.1 to 5.0
2021-11-17 15:46:13 -06:00
Ed Page
9753f68a76 revert: Default value behaviour with conflicts and requirement validation
This feature is too immature at this stage in the release.   See
clap-rs/clap Issue 3020 when bringing this feature back.

This reverts commit 301c6f765a.
This reverts commit 43a4c90c86.
This reverts commit 4e29777b21.
This reverts commit 69957c4ddd.
This reverts commit bdb1d324a5.
This reverts commit b102da0cd2.
This reverts commit 72429be14e.
This reverts commit 0b7def675b.
This reverts commit b86aa631be.
This reverts commit 6b458c602d.
2021-11-17 15:45:50 -06:00
Ed Page
6f70f65a24
Merge pull request #3 from epage/change
docs: Parent SubcommandPrecedenceOverArg under AppSettings
2021-11-17 15:45:33 -06:00
Ed Page
42f13977c3
Merge pull request #6 from epage/generic
feat(derive): Generic support
2021-11-17 15:45:19 -06:00
Ed Page
fa0b5477b7
Merge pull request #4 from epage/dependabot/cargo/pretty_assertions-1.0
chore(deps): Update pretty_assertions requirement from 0.7 to 1.0
2021-11-17 15:45:04 -06:00
dependabot[bot]
7737ce6946
chore(deps): Update os_str_bytes requirement from 4.1 to 5.0
Updates the requirements on [os_str_bytes](https://github.com/dylni/os_str_bytes) to permit the latest version.
- [Release notes](https://github.com/dylni/os_str_bytes/releases)
- [Commits](https://github.com/dylni/os_str_bytes/compare/4.1.0...5.0.0)

---
updated-dependencies:
- dependency-name: os_str_bytes
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-11-17 21:34:23 +00:00
dependabot[bot]
33240fcff3
chore(deps): Update pretty_assertions requirement from 0.7 to 1.0
Updates the requirements on [pretty_assertions](https://github.com/colin-kiegel/rust-pretty-assertions) to permit the latest version.
- [Release notes](https://github.com/colin-kiegel/rust-pretty-assertions/releases)
- [Changelog](https://github.com/colin-kiegel/rust-pretty-assertions/blob/main/CHANGELOG.md)
- [Commits](https://github.com/colin-kiegel/rust-pretty-assertions/compare/v0.7.0...v1.0.0)

---
updated-dependencies:
- dependency-name: pretty_assertions
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-11-17 21:34:15 +00:00
kuviman
aa6594b334 feat(derive): Generic support
This is a port of clap-rs/clap#3023
2021-11-17 15:33:59 -06:00
Ed Page
58b0fe537e
Merge pull request #2 from epage/boiler
chore: Align on boilerplate
2021-11-17 15:32:41 -06:00
Ed Page
4e546dd2a1 chore: Align on boilerplate 2021-11-17 15:24:50 -06:00
Ed Page
bbe32b2667 docs(examples): De-duplicate subcommand examples
Not seeing what this example adds over the other ones.  We've already
shown subcommands and shown that `App` has extra behavior for when
definint subcommands.
2021-11-17 15:23:31 -06:00
Ed Page
2ac2fc6005 docs(examples): Be explicit in multicall for what clap does
This better matches our other examples
2021-11-17 15:23:31 -06:00
Ed Page
3be8bcf756 docs(examples): Move unwrap comments to expect statements
This better models what users should be doing and makes it so all
comments are more clear.  In a prior commit, when a changed an `exit` to
`unwrap`, I disliked the fact that I was mixing an unwrap explanatory
comment in with another comment.  This makes them stand apart.
2021-11-17 15:23:31 -06:00
Ed Page
41d3b8f164 docs(examples): Remove unnecessary error check
Rather not confuse the point for users.
2021-11-17 15:23:31 -06:00
Ed Page
221c18bdec fix(error): Ensure value_of_t errors have trailing newline
Noticed this with `12_typed_values.rs`
2021-11-17 15:23:31 -06:00
Ed Page
7763a7c52a docs(examples): Focus subcommands on main call
The subcommand examples focus on the various ways of looking up
subcommands except for the main one people should be using.   This has
previously caused confusion, see https://github.com/clap-rs/clap/discussions/3000

To keep the examples focused, I only show `ArgMatches::subcommand`.  I
figure the examples are not exhaustive and that for the cases when
someone wants to do something more specialized, they can pull up the
API reference.
2021-11-17 15:23:31 -06:00
Ed Page
93948cc724 docs(examples): Work around non-commutative conflicts
The comments in these examples say that a `conflicts_with` should
override `required`.  This seems to be true one way but not the other,
causing these examples to error out at runtime.
2021-11-17 15:23:31 -06:00
Ed Page
4eba65bfaf docs(examples): Don't use is_present with subcommands
Apparently, this isn't supported anymore.
2021-11-17 15:23:31 -06:00
Ed Page
1f0d86a407 docs(examples): Highlight possible-values in help
Instead of showing the user how to do things manually, let's make the
contrast in `--help` more obvious by not manually listing the possible
values.
2021-11-17 15:23:31 -06:00