Commit graph

81 commits

Author SHA1 Message Date
Orhun Parmaksız
2740be259c
fix(man): show the environment info with separate paragraph (#3631)
This commit updates the man page renderer to use a relative margin
indent for environment variable text instead of appending to the
existing help text.

Signed-off-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
Fixes: #3630
2022-04-20 08:50:11 -05:00
Ed Page
cad55a2de2 chore: Release 2022-04-19 11:50:17 -05:00
Benjamin Gilbert
d50ab883aa fix(man): Explicitly depend on clap 3.1.10
Command.build() is not available in 3.1.9.

Fixes: 8f182067e3 ("feat(clap): Publicly expose `Command::build`")
2022-04-19 12:30:39 -04:00
Ed Page
0194568b03 chore: Release 2022-04-19 10:31:52 -05:00
Ed Page
8f182067e3 feat(clap): Publicly expose Command::build
`Command::_build_all` started as an internal function for
`clap_complete` as a stopgap until #2911.  Overtime, we've been finding
more cases where this function needs to be called, so now we're going to
fully embrace it until #2911 so people aren't scrared off by the hidden
implementation from using it.

This was inspired by #3602

Comptibility: Though this adds a deprecation which we general reserve
for minor or major versions, this is enough of a corner case that I'm
fine doing this in a patch release.
2022-04-19 10:13:43 -05:00
Ed Page
297b9cf594 chore: Release 2022-04-15 14:05:51 -05:00
Ed Page
b3cbfd0ae0 docs(man): Update changelog 2022-04-15 14:05:29 -05:00
Ed Page
858f184428
Merge pull request #3587 from ducaale/value-name-as-header-positional
Use `Arg::value_name()` as header for positionals in clap_mangen
2022-04-04 09:56:41 -05:00
ducaale
fbfeaabfd1 fix(clap_mangen): Use italic for replaceble args 2022-04-03 13:35:30 +01:00
Ed Page
e91d18ba0e
Merge pull request #3605 from ducaale/synopsis-hidden-flags
Don't include hidden flags in the synopsis section from clap_mangen
2022-04-02 19:59:50 -05:00
ducaale
ddc83bfdc8 test(clap_mangen): Hidden flags in synopsis 2022-04-03 00:28:31 +01:00
ducaale
b3b49855ab fix(clap_mangen): Hide hidden flags in synopsis 2022-04-03 00:11:45 +01:00
ducaale
99d6737521 fix(clap_mangen): Update snapshot tests 2022-04-03 00:03:02 +01:00
ducaale
fbd33891b4 fix(clap_mangen): Use value_names for positionals 2022-03-28 21:22:18 +01:00
ducaale
d55e46f65f docs(mangen): Fix docs for Man::section() 2022-03-26 17:49:34 +00:00
Ed Page
7c86eeb176 test(man): Add snapshot tests 2022-03-07 14:12:59 -06:00
Ed Page
d7a35137e3 chore: Release 2022-02-16 12:01:29 -06:00
Ed Page
e6729f96c3 chore: Release 2022-02-16 11:59:45 -06:00
Ed Page
e8010e79a9 refactor: Update app variables to cmd 2022-02-14 15:55:56 -06:00
Ed Page
c4144d7d6c docs: Update App references to Command 2022-02-14 15:33:49 -06:00
Ed Page
77542a1138 refactor: Reduce visibility on App members
The long term goals are
- Easier refactoring
- Identify needs for reflection API

Shorter term, if I want to rename `App` to `Command` and deprecate
`App`, it will mark all member access as deprecated.  This works around
that.

I gave up in exploring abstractions when it came to `MKeyMap` access.
This can be refined in the future.
2022-02-14 14:17:48 -06:00
Ed Page
4895a32e81 fix: Deprecate SubcommandRequiredElseHelp
Now that we can use `SubcommandRequired |
ArgRequiredElseHelp`, this setting offers little value but requires we
track required subcommands with two different settings.  Deprecating as
the cost is not worth the benefit anymore.

Issue #3280 will see the derive updated
2022-02-11 15:31:25 -06:00
Ed Page
d3f5d7ce34 fix: Clarify Arg/ArgGroup id's role
This adjusts names.  Adjusting the derive naming (and re-naming) is left
to #2475.

Fixes #3335
2022-02-11 14:11:50 -06:00
Ed Page
272f840178 feat: Replace core set of AppSettings with functions
This is a part of #2717

Some settings didn't get getters because
- They are transient parse settings (e.g. ignore errors)
- They get propagated to args and should be checked there

`is_allow_hyphen_values_set` is a curious case.  In some cases, we only
check the app and not an arg.  This seems suspicious.
2022-02-11 12:35:09 -06:00
Ed Page
48686804c7 docs(man): Fix links 2022-02-10 13:54:29 -06:00
Ed Page
47d76742eb feat: Add Arg getters for all settings
This is prep for #2717
2022-02-10 10:18:41 -06:00
Ed Page
135b15467e chore: Release 2022-02-08 10:28:40 -06:00
Ed Page
1330a46bf0 docs: Update changelog 2022-02-08 10:28:27 -06:00
Ed Page
6cd069ab5d docs: Expand doc comments 2022-02-08 10:10:22 -06:00
Ed Page
c5080f1139 docs(man): Fill our README 2022-02-08 09:59:57 -06:00
Ed Page
86bf680645 fix(man): Rename crate to match style
I have access to the `clap-man` name but we use `clap_*`.  Rather than
people getting mixed up on which is supposed to use, we went with a
different name.
2022-02-07 20:20:01 -06:00