Incorrect synopsis for char[] options

[rsenden]

I have some password options defined like the following:

@Option(names = {"--password", "-p"}, interactive = true, echo = false, arity = "0..1", required = true)
@Getter private char[] password;

Likely due to this option being defined as an array, the command synopsis in help output and man page show this as a repeatable option:

-p[=<password>] [-p[=<password>]]...

This is confusing for users, as it makes them think they can specify multiple passwords, whereas in reality they can only specify a single password consisting of multiple characters.

[remkop]

I see, yes.
The logic for that lives in CommandLine.Help#concatOptionText.

Current:

                if (option.required()) { // e.g., -x=VAL
                    text = text.concat(name).concat(param).concat("");
                    if (option.isMultiValue()) { // e.g., -x=VAL [-x=VAL]...
                        text = text.concat(" [").concat(name).concat(param).concat("]...");
                    }
                } else {
                    text = text.concat("[").concat(name).concat(param).concat("]");
                    if (option.isMultiValue()) { // add ellipsis to show option is repeatable
                        text = text.concat("...");
                    }
                }

potential fix:

                // related: Interpreter#getActualTypeConverter special logic for interactive char[] options... (also: #648)
                boolean treatAsSingleValue = char[].class.equals(option.type()) && option.interactive(); // #1834

                if (option.required()) { // e.g., -x=VAL
                    text = text.concat(name).concat(param).concat("");
                    if (option.isMultiValue() && !treatAsSingleValue) { // e.g., -x=VAL [-x=VAL]...
                        text = text.concat(" [").concat(name).concat(param).concat("]...");
                    }
                } else {
                    text = text.concat("[").concat(name).concat(param).concat("]");
                    if (option.isMultiValue() && !treatAsSingleValue) { // add ellipsis to show option is repeatable
                        text = text.concat("...");
                    }
                }

Will you be able to provide a unit test?

[rsenden]

I'll look into providing a PR with fix and unit test either myself or by my colleague.

[remkop]

Looking at this more closely, I think #1846 (treating char[] as single value type) is a better solution. I will make the changes.