Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split help into several screens #1480

Open
CharliePoole opened this issue Sep 15, 2024 · 2 comments
Open

Split help into several screens #1480

CharliePoole opened this issue Sep 15, 2024 · 2 comments
Assignees
Milestone

Comments

@CharliePoole
Copy link
Collaborator

The help screen is getting very long. While it's possible to send the output to more, that loses the color display because of how our implementation of ColorConsole works. So I'd like to create an internal implementation that looks like more, but without a an of the options it supports.

  1. Initial output will fill the screen with -- More -- on the last line.
  2. Pressing enter will advance one line
  3. Pressing space will advance one page
  4. Pressing 'q' or 'Q' will exit.
@veleek
Copy link
Member

veleek commented Sep 22, 2024

IMO I don't think this is a problem that we should be solving with the runner. The color in the output only provides a marginal benefit (we're highlighting the headers in one color and all of the body text is in green, there's no syntax highlighting or anything like that to make things clearer) and I think it's better to just support whatever default pagination method the platform provides.

I would support either:

  1. Add a "simple" help page that outputs by default and provide additional arguments for more detailed output.
  2. Determine if there's a way to support colored console output that doesn't break when piping to a pager.

@CharliePoole
Copy link
Collaborator Author

Yeah. I think you're right about the pagination. Maybe a short page displayed for simple --help or --help:usage and a longer one for --help:options, etc.

@CharliePoole CharliePoole changed the title Paginate output from the help command Split help into several screents Sep 30, 2024
@CharliePoole CharliePoole self-assigned this Sep 30, 2024
@CharliePoole CharliePoole added this to the 3.18.3 milestone Sep 30, 2024
@CharliePoole CharliePoole changed the title Split help into several screents Split help into several screens Sep 30, 2024
@CharliePoole CharliePoole modified the milestones: 3.18.3, 3.19.0 Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants