linode-cli icon indicating copy to clipboard operation
linode-cli copied to clipboard

new: Improve generated command help page formatting using Rich

Open lgarber-akamai opened this issue 1 year ago • 0 comments

📝 Description

This change makes various large formatting improvements to command help pages, including:

  • Bolding help page sections
  • Adding color/bolding to argument names and prefixes
  • Grouping arguments by parent and whether they are required
  • Applying indentation to child arguments
  • Converting Markdown links to human-readable absolute links

Additionally, this PR moves help page helpers from arg_helpers.py to a new help_pages.py file in an effort to keep files tightly scoped

✔️ How to Test

The following test steps assume you have pulled this code locally and run make install.

Unit Testing

make testunit

Integration Testing

make testint

Manual Testing

  1. View the help page for any CLI command (e.g. linode-cli linodes ls --help).
  2. Ensure the output matches the criteria mentioned in the description and is readable/understandable.

📷 Preview

linodes ls linodes create
linode-cli linodes ls --help linode-cli linodes create --help (arguments)
firewalls update firewalls delete
linode-cli firewalls update --help linode-cli firewalls delete --help

lgarber-akamai avatar Mar 05 '24 19:03 lgarber-akamai