Paginate help output #824
Merged
Paginate help output #824
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
martinvonz
reviewed
Dec 1, 2022
chooglen
commented
Dec 1, 2022
martinvonz
reviewed
Dec 1, 2022
chooglen
force-pushed
the
push-d4cab3ac55474a2f822f3c85ce7a1590
branch
2 times, most recently
from
986b816 to
3395683
Compare
This does not respect "--no-pager", support will be added in the next commit.
martinvonz
approved these changes
Dec 13, 2022
chooglen
force-pushed
the
push-d4cab3ac55474a2f822f3c85ce7a1590
branch
from
3395683 to
62e91b9
Compare
Clap bails parsing when an "error" is encountered, e.g. a subcommand is missing, "--help" is passed, or the "help" subcommand is invoked. This means that the current approach of parsing args does not handle flags like `--no-pager` or `--color` when an error is encountered. Fix this by separating early args into their own struct and preprocessing them using `ignore_errors` (per clap-rs/clap#1880). The early args are in a new `EarlyArgs` struct because of a known bug where `ignore_errors` causes default values not to be respected (clap-rs/clap#4391 specifically calls out bool, but strings may also be ignored), so when `ignore_errors` is given, the default values will be missing and parsing will fail unless the right arg types are used (e.g`. Option`). By parsing only early args (using the new struct) we only need to adjust `no_pager`, instead of adjusting all args with a default value.
chooglen
force-pushed
the
push-d4cab3ac55474a2f822f3c85ce7a1590
branch
from
62e91b9 to
986801a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It can be useful to paginate the help output (e.g.
jj help) for easy reading. This should also support--no-pagerfor users who prefer not to use pagination, but because of howclapparsehelp(and others), this requires changing how we parse global args (see the second commit). As a side-benefit, we can now pass--colortojj help.This is still a WIP because this does not have tests.
Checklist
If applicable:
CHANGELOG.mdCHANGELOG.md(optional)