[
https://issues.apache.org/jira/browse/CLI-169?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12635363#action_12635363
]
J. Lewis Muir commented on CLI-169:
-----------------------------------
OK, I'm trying again.
I've added a {{longOptNameArgSeparator}} property to {{HelpFormatter}} to allow
the long option name-argument separator to be specified. The default is still
the space character to maintain backward compatibility.
Now, if you have an option like:
{code}
Option option = new Option("B", "bsize", true, "block size in bytes");
option.setArgName("SIZE");
{code}
and you call {{setLongOptNameArgSeparator('=')}} on a {{HelpFormatter}}
instance, the option would be rendered by that instance in the help message as:
{noformat}
-B,--bsize=<SIZE>
{noformat}
Attached is a patch with test cases.
Since this is now really a feature addition, I would understand if it can't go
into the next release. But I think it would be great if it could.
> HelpFormatter ignores Option's value separator
> ----------------------------------------------
>
> Key: CLI-169
> URL: https://issues.apache.org/jira/browse/CLI-169
> Project: Commons CLI
> Issue Type: Bug
> Components: Help formatter
> Affects Versions: 1.2
> Reporter: J. Lewis Muir
> Fix For: 1.2
>
> Attachments: long-opt-name-arg-separator.patch,
> use-value-separator-in-help-formatter.patch
>
> Original Estimate: 0.5h
> Remaining Estimate: 0.5h
>
> The HelpFormatter always renders a space between the option name and value
> even if the option has a value separator that is not a space. For example,
> this option:
> {code}
> Option option = new Option("B", "bsize", true, "block size in bytes");
> option.setArgName("SIZE");
> option.setValueSeparator('=');
> {code}
> is rendered like this:
> {noformat}
> -B,--bsize <SIZE> block size in bytes
> {noformat}
> But I would expect it to be rendered like this:
> {noformat}
> -B,--bsize=<SIZE> block size in bytes
> {noformat}
> For the automatically generated usage message, a similar problem exists. I
> changed it to try to use the value separator when rendering the option with
> the short name only if there's no long name. If there's no short name, it
> always tries to use the value separator with the long name rendering.
> For example, consider this option containing a short name and a specified
> value separator:
> {code}
> Option option = new Option("B", true, "block size in bytes");
> option.setArgName("SIZE");
> option.setValueSeparator('=');
> {code}
> The automatically generated usage message with my changes would look like
> this:
> {noformat}
> usage: app [-B=<SIZE>]
> {noformat}
> If the same option included a long name too:
> {code}
> Option option = new Option("B", "bsize", true, "block size in bytes");
> option.setArgName("SIZE");
> option.setValueSeparator('=');
> {code}
> with my changes the value separator is assumed to be meant for use with the
> long name. The short option rendering in the usage message will not try to
> use the value separator and will render the usage message like this:
> {noformat}
> usage: app [-B <SIZE>]
> {noformat}
> Attached is a patch for these fixes with test cases. The patch is against
> [http://svn.apache.org/repos/asf/commons/proper/cli/branches/cli-1.x].
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
