[CLI-339] Help formatter framework is hard to extend.

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.9.0
• Fix Version/s: 1.10.0
• Component/s: Help formatter
• Assignee: Claude Warren
• Reporter: Claude Warren
• Created: 28/Sep/24 12:49
• Updated: 17/Oct/24 16:24
• Resolved: 17/Oct/24 16:24

Description

The current HelpFormatter implementation makes it difficult to extend and in some cases reuse components.  The goal here is to create a help formatting framework that:

• Supports all the current format configuration options
• Is easily tested
• provides ability to easily define and format the options table.  This is the section of the help that currently lists the short & long option with arg name as the first column, the optional "since" column, and a description column that may contain deprecation information.
• Provides the ability to easily add additional tables to the output.  This implies access to the text wrapping functionality and formatting functionality.
• Ability to output multiple formats.  Current implementation only supports text output.  There has been discussion of desire for several other formats.

 

Issue Links

• links to: GitHub Pull Request #314