Skip to content

Fix completion for positional arguments after the command #1346 #1355

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
+59 −7
Open

Fix completion for positional arguments after the command #1346 #1355

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
13 changes: 8 additions & 5 deletions spring-shell-jline/src/main/java/org/springframework/shell/jline/CommandCompleter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,20 +93,23 @@ private boolean isOptionPresent(ParsedLine line, CommandOption option) {
}

@Nullable private Command findCommandByWords(List<String> words) {
Command match = null;
StringBuilder commandName = new StringBuilder();
for (String word : words) {
if (word.startsWith("-")) {
break;
}
commandName.append(word).append(" ");
Command candidate = this.commandRegistry.getCommandByName(commandName.toString().trim());
if (candidate != null) {
match = candidate;
}
}

Command command = this.commandRegistry.getCommandByName(commandName.toString().trim());
// the command is found but was not completed on the line
if (command != null && getCommandNames(command).toList().contains(String.join(" ", words))) {
command = null;
if (match != null && getCommandNames(match).toList().contains(String.join(" ", words))) {
match = null;
}
return command;
return match;
}

@Nullable private CommandOption findOptionByWords(List<String> words, List<CommandOption> options) {
Expand Down
53 changes: 51 additions & 2 deletions spring-shell-jline/src/test/java/org/springframework/shell/jline/CommandCompleterTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,13 @@ static Stream<Arguments> completeData() {
Arguments.of(List.of("hello", "--first", "Paul", "--last=Noris", ""), List.of()),
Arguments.of(List.of("hello", "--first", "Paul", "-l=Noris", ""), List.of()),
Arguments.of(List.of("hello", "-f", "Paul", "--last=Noris", ""), List.of()),
Arguments.of(List.of("hello", "-f", "Paul", "-l=Noris", ""), List.of()));
Arguments.of(List.of("hello", "-f", "Paul", "-l=Noris", ""), List.of()),

// positional arguments after the command should not break completion
// (gh-1346)
Arguments.of(List.of("hello", "IN"), List.of("--first", "--last", "-f", "-l")),
Arguments.of(List.of("hello", "INBOUND"), List.of("--first", "--last", "-f", "-l")),
Arguments.of(List.of("hello", "IN", ""), List.of("--first", "--last", "-f", "-l")));
}

@ParameterizedTest
Expand Down Expand Up @@ -326,7 +332,12 @@ static Stream<Arguments> completeWithSubCommandsData() {

Arguments.of(List.of("hello world", "--first", ""), List.of("Mary", "Paul", "Peter")),
Arguments.of(List.of("hello world", "--last", ""), List.of("Chan", "Noris")),
Arguments.of(List.of("hello world", "--first", "Paul", "--last", "Noris", ""), List.of()));
Arguments.of(List.of("hello world", "--first", "Paul", "--last", "Noris", ""), List.of()),

// positional arguments after a multi-word command should not break
// completion (gh-1346)
Arguments.of(List.of("hello world", "IN"), List.of("--first", "--last", "-f", "-l")),
Arguments.of(List.of("hello world", "IN", ""), List.of("--first", "--last", "-f", "-l")));
}

@ParameterizedTest
Expand Down Expand Up @@ -486,4 +497,42 @@ static Stream<Arguments> completeForCommandAlias() {
Arguments.of(List.of("bye", ""), List.of()));
}

@ParameterizedTest
@MethodSource("completeForPositionalArgumentData")
void testCompleteForPositionalArgument(List<String> words, List<String> expectedValues) {
// given
CompletionProvider positionalProvider = completionContext -> {
if (completionContext.getCommandOption() != null) {
return Collections.emptyList();
}
String typed = completionContext.getWords().get(completionContext.getWordIndex());
return Stream.of("INBOUND", "OUTBOUND", "INTERNAL")
.filter(v -> v.startsWith(typed))
.map(CompletionProposal::new)
.toList();
};
when(command.getCompletionProvider()).thenReturn(positionalProvider);
when(command.getOptions()).thenReturn(List.of());

List<Candidate> candidates = new ArrayList<>();
ParsedLine line = mock(ParsedLine.class);
when(line.words()).thenReturn(words);
when(line.wordIndex()).thenReturn(words.size() - 1);
when(line.word()).thenReturn(words.get(words.size() - 1));
when(line.line()).thenReturn(String.join(" ", words));

// when
completer.complete(mock(LineReader.class), line, candidates);

// then
assertEquals(expectedValues, toCandidateNames(candidates));
}

static Stream<Arguments> completeForPositionalArgumentData() {
return Stream.of(Arguments.of(List.of("hello", ""), List.of("INBOUND", "INTERNAL", "OUTBOUND")),
Arguments.of(List.of("hello", "IN"), List.of("INBOUND", "INTERNAL")),
Arguments.of(List.of("hello", "INBOUND"), List.of("INBOUND")),
Arguments.of(List.of("hello", "OUT"), List.of("OUTBOUND")));
}

}
Loading