Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix issue with groups not being reported in help output. #411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
garydgregory merged 4 commits into from
Nov 5, 2025
Merged

Fix issue with groups not being reported in help output. #411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fb8b275
Fix issue with groups not being reported in help output.
Claudenw Nov 1, 2025
0c72629
Don't break binary compatibility
garydgregory Nov 1, 2025
1cbac2f
Restore test
garydgregory Nov 1, 2025
9a34a87
fixed issues arising from reverting incompatible binary changes
Claudenw Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ public final String getSyntaxPrefix() {
* @param autoUsage whether to print an automatically generated usage statement.
* @throws IOException If the output could not be written to the {@link HelpAppendable}.
*/
public void printHelp(final String cmdLineSyntax, final String header, final Iterable<Option> options, final String footer, final boolean autoUsage)
public void printHelp(final String cmdLineSyntax, final String header, final Options options, final String footer, final boolean autoUsage)
throws IOException {
if (Util.isEmpty(cmdLineSyntax)) {
throw new IllegalArgumentException("cmdLineSyntax not provided");
Expand All @@ -306,7 +306,7 @@ public void printHelp(final String cmdLineSyntax, final String header, final Ite
if (!Util.isEmpty(header)) {
helpAppendable.appendParagraph(header);
}
helpAppendable.appendTable(getTableDefinition(options));
helpAppendable.appendTable(getTableDefinition(options.getOptions()));
if (!Util.isEmpty(footer)) {
helpAppendable.appendParagraph(footer);
}
Expand All @@ -317,14 +317,16 @@ public void printHelp(final String cmdLineSyntax, final String header, final Ite
*
* @param cmdLineSyntax the syntax for this application.
* @param header the banner to display at the beginning of the help.
* @param options the {@link Options} to print.
* @param options the collection of {@link Option} objects to print.
* @param footer the banner to display at the end of the help.
* @param autoUsage whether to print an automatically generated usage statement.
* @throws IOException If the output could not be written to the {@link HelpAppendable}.
*/
public final void printHelp(final String cmdLineSyntax, final String header, final Options options, final String footer, final boolean autoUsage)
public void printHelp(final String cmdLineSyntax, final String header, final Iterable<Option> options, final String footer, final boolean autoUsage)
throws IOException {
printHelp(cmdLineSyntax, header, options.getOptions(), footer, autoUsage);
Options optionsObject = new Options();
options.forEach(optionsObject::addOption);
printHelp(cmdLineSyntax, header, optionsObject, footer, autoUsage);
}

/**
Expand Down Expand Up @@ -403,7 +405,11 @@ public final String toArgName(final String argName) {

/**
* Return the string representation of the options as used in the syntax display.
*
* <p>
* This is probably not the method you want. This method does not track the presence
* of option groups. To display the option grouping use {@link #toSyntaxOptions(Options)} or
* {@link #toSyntaxOptions(OptionGroup)} for individual groups.
* </p>
* @param options The collection of {@link Option} instances to create the string representation for.
* @return the string representation of the options as used in the syntax display.
*/
Expand Down
103 changes: 103 additions & 0 deletions src/test/java/org/apache/commons/cli/help/HelpFormatterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,85 @@ void testPrintHelp() throws IOException {
assertEquals(0, sb.length(), "Should not write to output");
}

@Test
public void testPrintHelpWithIterableOptions() throws IOException {
final StringBuilder sb = new StringBuilder();
final TextHelpAppendable serializer = new TextHelpAppendable(sb);
HelpFormatter formatter = HelpFormatter.builder().setHelpAppendable(serializer).get();

final List<Option> options = new ArrayList<>();
options.add(Option.builder("a").since("1853").hasArg().desc("aaaa aaaa aaaa aaaa aaaa").build());

List<String> expected = new ArrayList<>();
expected.add(" usage: commandSyntax [-a <arg>]");
expected.add("");
expected.add(" header");
expected.add("");
expected.add(" Options Since Description ");
expected.add(" -a <arg> 1853 aaaa aaaa aaaa aaaa aaaa");
expected.add("");
expected.add(" footer");
expected.add("");

formatter.printHelp("commandSyntax", "header", options, "footer", true);
List<String> actual = IOUtils.readLines(new StringReader(sb.toString()));
assertEquals(expected, actual);

formatter = HelpFormatter.builder().setShowSince(false).setHelpAppendable(serializer).get();
expected = new ArrayList<>();
expected.add(" usage: commandSyntax [-a <arg>]");
expected.add("");
expected.add(" header");
expected.add("");
expected.add(" Options Description ");
expected.add(" -a <arg> aaaa aaaa aaaa aaaa aaaa");
expected.add("");
expected.add(" footer");
expected.add("");

sb.setLength(0);
formatter.printHelp("commandSyntax", "header", options, "footer", true);
actual = IOUtils.readLines(new StringReader(sb.toString()));
assertEquals(expected, actual);

sb.setLength(0);
formatter.printHelp("commandSyntax", "header", options, "footer", false);
expected.set(0, " usage: commandSyntax");
actual = IOUtils.readLines(new StringReader(sb.toString()));
assertEquals(expected, actual);

sb.setLength(0);
formatter.printHelp("commandSyntax", "", options, "footer", false);
expected.remove(3);
expected.remove(2);
actual = IOUtils.readLines(new StringReader(sb.toString()));
assertEquals(expected, actual);

sb.setLength(0);
formatter.printHelp("commandSyntax", null, options, "footer", false);
actual = IOUtils.readLines(new StringReader(sb.toString()));
assertEquals(expected, actual);

sb.setLength(0);
formatter.printHelp("commandSyntax", null, options, "", false);
expected.remove(6);
expected.remove(5);
actual = IOUtils.readLines(new StringReader(sb.toString()));
assertEquals(expected, actual);

sb.setLength(0);
formatter.printHelp("commandSyntax", null, options, null, false);
actual = IOUtils.readLines(new StringReader(sb.toString()));
assertEquals(expected, actual);

sb.setLength(0);
final HelpFormatter fHelp = formatter;
assertThrows(IllegalArgumentException.class, () -> fHelp.printHelp("", "header", options, "footer", true));
assertEquals(0, sb.length(), "Should not write to output");
assertThrows(IllegalArgumentException.class, () -> fHelp.printHelp(null, "header", options, "footer", true));
assertEquals(0, sb.length(), "Should not write to output");
}

/**
* Tests example from the mailing list that caused an infinite loop.
*
Expand Down Expand Up @@ -415,4 +494,28 @@ void testToSyntaxOptionOptionsTest() {
"options with required group failed");
}

@Test
void verifyOptionGroupingOutput() throws IOException {
// create options and groups
final Option o1 = new Option("o1", "Descr");
final Option o2 = new Option("o2", "Descr");

final Options options = new Options();
options.addOption(o1);
options.addOption(o2);

final OptionGroup group = new OptionGroup();
group.addOption(o1);
group.addOption(o2);
options.addOptionGroup(group);

final StringBuilder output = new StringBuilder();
//format options with new formatter
final org.apache.commons.cli.help.HelpFormatter newFormatter =
org.apache.commons.cli.help.HelpFormatter.builder().setShowSince(false)
.setHelpAppendable(new TextHelpAppendable(output)).get();
newFormatter.printHelp("Command", null, options, null, true);
assertTrue(output.toString().contains("[-o1 | -o2]"));
}

}