Align and wrap description, usage, flags, and commands

[richard-viney]

• Wraps all help output to a max width.
• New config options for max output width (default 80 chars), min first column width (default 2 spaces), and column gap (default 2 spaces).
• Flag and command names and descriptions are now aligned and descriptions wrap onto multiple lines
• Usage text also wraps
• Snapshot tests updated to include the above

Could also consider adding a blank line between each command and/or flag. Maybe it should be configurable?

[TanklesXL]

@richard-viney this is awesome, thanks for tackling this! I'll hopefully have time to take a look in the next few days

[TanklesXL]

🥳
Wow this is great! I really appreciate you picking up this ticket, I've left some preliminary style suggestions while I attempt to better understand the wrapping math that's being done here.

Some additional thoughts that I had at first glance:

• The maximum width should be user-configurable and defined as a field in the Config, this field can continue to default to 100 as you have here but i suspect some users will want to customize the max (with 80 likely being the most common default)
• There will need to be at least 1 new test case to for the alignment and wrapping behaviour for long subcommand names and descriptions. All current subcommands in the help text tests have very short names and descriptions and will thus not exercise this behaviour
• I would really appreciate some inline comments detailing the logic & math for the wrapping and alignment, both in the utils.gleam as well as where the wrapping is being used in glint.gleam
  • This will be super helpful for me when I inevitably need to remember what all of this is doing 😄
  • no need to go overboard, but definitely don't worry about being too verbose

[richard-viney]

Ready for another look!

[richard-viney]

The default max output width is now 80 chars to match what gleam format uses.

[TanklesXL]

This looks great, i'm going to merge it now! Thanks @richard-viney 💜