You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by "Claude Warren (Jira)" <ji...@apache.org> on 2024/10/17 16:25:00 UTC

[jira] [Resolved] (CLI-339) Help formatter framework is hard to extend.

     [ https://issues.apache.org/jira/browse/CLI-339?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Claude Warren resolved CLI-339.
-------------------------------
    Fix Version/s: 1.10.0
       Resolution: Fixed

> Help formatter framework is hard to extend.
> -------------------------------------------
>
>                 Key: CLI-339
>                 URL: https://issues.apache.org/jira/browse/CLI-339
>             Project: Commons CLI
>          Issue Type: Improvement
>          Components: Help formatter
>    Affects Versions: 1.9.0
>            Reporter: Claude Warren
>            Priority: Major
>             Fix For: 1.10.0
>
>
> 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|https://lists.apache.org/thread/2powlgz6msqk6hqql55oo0fpgvb4x9kz] of desire for several other formats.
>  



--
This message was sent by Atlassian Jira
(v8.20.10#820010)