Cli: Help text should automatically wrap based on term width

Created on 20 Oct 2015  路  16Comments  路  Source: urfave/cli

When we got a long text description in Usage, it should automatically wrap and make a nice display.
A bit like what "man" does, it automatically rewraps the text so it fits nicely in the current terminal session.

arev2 help wanted kinfeature statuconfirmed

Most helpful comment

This feature is now in review - @urfave/cli please add a 馃憤 or 馃憥 to the top post if you're in favor or against this feature being added!

All 16 comments

+1

+1

+1

and should be able to handle \n in the various command and flag descriptions, indenting appropriately.

...or simply wrap at 80 characters, which is considered a common default and also adheres to general readability best-practises.

This feature is now in review - @urfave/cli please add a 馃憤 or 馃憥 to the top post if you're in favor or against this feature being added!

@lynncyrin we should move forward with this one. Wrapping based on the term width seems a sane default. :)

馃憖 this is now ready for anyone to work on!

...or simply wrap at 80 characters, which is considered a common default and also adheres to general readability best-practises.

I agree that an 80 character limit would be easier to read. It would also be easier to implement. That said, I don't want to bikeshed this issue. Whoever actually does the work to implement this will have my vote.

I will try to make #1119 implement a basic version of this feature.

This issue or PR has been automatically marked as stale because it has not had recent activity. Please add a comment bumping this if you're still interested in it's resolution! Thanks for your help, please let us know if you need anything else.

Bump.

This issue or PR has been bumped and is no longer marked as stale! Feel free to bump it again in the future, if it's still relevant.

This issue or PR has been automatically marked as stale because it has not had recent activity. Please add a comment bumping this if you're still interested in it's resolution! Thanks for your help, please let us know if you need anything else.

Bump.

This issue or PR has been bumped and is no longer marked as stale! Feel free to bump it again in the future, if it's still relevant.

Was this page helpful?
0 / 5 - 0 ratings