Skip to content

Fix implicit --help option for sub-commands #1369

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

Open
czpilar wants to merge 1 commit into
base: main
Choose a base branch
from
+29 −2
Open

Fix implicit --help option for sub-commands #1369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 additions & 2 deletions ...shell-core/src/main/java/org/springframework/shell/core/command/DefaultCommandParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,12 +195,20 @@ private String unquoteAndUnescapeQuoted(String s) {
}

private boolean isBooleanOption(String commandName, String currentWord) {
return Optional.ofNullable(commandRegistry.getCommandByName(commandName))
List<CommandOption> declaredOptions = Optional.ofNullable(commandRegistry.getCommandByName(commandName))
.map(Command::getOptions)
.orElse(List.of())
.stream()
.filter(o -> o.isOptionEqual(currentWord))
.anyMatch(o -> o.type() == boolean.class || o.type() == Boolean.class);
.toList();
if (declaredOptions.isEmpty()) {
return isHelpOption(currentWord);
}
return declaredOptions.stream().anyMatch(o -> o.type() == boolean.class || o.type() == Boolean.class);
}

private boolean isHelpOption(String word) {
return word.equals("--help") || word.equals("-h");
}

private boolean isBooleanValue(String rawValue) {
Expand Down
19 changes: 19 additions & 0 deletions ...-core/src/test/java/org/springframework/shell/core/command/DefaultCommandParserTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,6 +482,25 @@ void testParseWithHelpOption(String input) {
assertEquals("true", parsedInput.options().get(0).value());
}

@ParameterizedTest
@ValueSource(strings = { "mycommand mysubcommand --help", "mycommand mysubcommand -h",
"mycommand --help arg1 --option value1", "mycommand -h arg1" })
void testParseWithImplicitHelpOption(String input) {
// given
Command command = createCommand("mycommand", "My test command");
command.getOptions().add(CommandOption.with().longName("option").shortName('o').build());
commandRegistry.registerCommand(command);
Command subCommand = createCommand("mycommand mysubcommand", "My test sub command");
subCommand.getOptions().add(CommandOption.with().longName("option").shortName('o').build());
commandRegistry.registerCommand(subCommand);

// when
ParsedInput parsedInput = parser.parse(input);

// then
assertEquals("true", parsedInput.options().get(0).value());
}

private static Command createCommand(String name, String description) {
return new AbstractCommand(name, description) {
@Override
Expand Down
Loading