Skip to content

Fixed completion only for particular command option (#1246) #1247

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

Closed
czpilar wants to merge 2 commits into from
+35 −9
Closed

Fixed completion only for particular command option (#1246) #1247

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eae760e
Fixed completion only for particular command option (#1246)
czpilar Dec 26, 2025
29f8985
Fixed completion only for particular command option (#1246)
czpilar Dec 26, 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
44 changes: 35 additions & 9 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 @@ -12,12 +12,15 @@
import org.springframework.shell.core.command.completion.CompletionProposal;
import org.springframework.shell.core.command.completion.CompletionProvider;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
* A JLine {@link Completer} that completes command names from a {@link CommandRegistry}.
*
* @author Mahmoud Ben Hassine
* @author David Pilar
* @since 4.0.0
*/
public class CommandCompleter implements Completer {
Expand All @@ -36,20 +39,24 @@ public CommandCompleter(CommandRegistry commandRegistry) {
public void complete(LineReader reader, ParsedLine line, List<Candidate> candidates) {
Command commandByName = findCommandByWords(line.words());
if (commandByName != null) {
// add option completions for the command
List<CommandOption> options = commandByName.getOptions();
for (CommandOption option : options) {
if (option.longName() != null && !line.line().contains("--" + option.longName())) {
candidates.add(new Candidate("--" + option.longName()));
}
if (option.shortName() != ' ' && !line.line().contains("-" + option.shortName())) {
candidates.add(new Candidate("-" + option.shortName()));
CommandOption commandOption = findOptionByWords(line.words(), options);
if (commandOption == null) {
// add option completions for the command
for (CommandOption option : options) {
boolean present = isOptionPresent(line, option);
if (option.longName() != null && !present) {
candidates.add(new Candidate("--" + option.longName()));
}
if (option.shortName() != ' ' && !present) {
candidates.add(new Candidate("-" + option.shortName()));
}
}
}
// add custom completions from the command's completion provider
CompletionProvider completionProvider = commandByName.getCompletionProvider();
CompletionContext context = new CompletionContext(line.words(), line.wordIndex(), line.wordCursor(), null,
null);
CompletionContext context = new CompletionContext(line.words(), line.wordIndex(), line.wordCursor(),
commandByName, commandOption);
List<CompletionProposal> proposals = completionProvider.apply(context);
for (CompletionProposal proposal : proposals) {
candidates.add(new Candidate(proposal.value()));
Expand All @@ -63,6 +70,11 @@ public void complete(LineReader reader, ParsedLine line, List<Candidate> candida
}
}

private boolean isOptionPresent(ParsedLine line, CommandOption option) {
return option.longName() != null && line.line().contains(" --" + option.longName() + " ")
|| option.shortName() != ' ' && line.line().contains(" -" + option.shortName() + " ");
}

@Nullable private Command findCommandByWords(List<String> words) {
StringBuilder commandName = new StringBuilder();
for (String word : words) {
Expand All @@ -74,4 +86,18 @@ public void complete(LineReader reader, ParsedLine line, List<Candidate> candida
return this.commandRegistry.getCommandByName(commandName.toString().trim());
}

@Nullable private CommandOption findOptionByWords(List<String> words, List<CommandOption> options) {
List<String> reversed = new ArrayList<>(words);
Collections.reverse(reversed);
String optionName = reversed.stream().filter(word -> !word.trim().isEmpty()).findFirst().orElse("");

for (CommandOption option : options) {
if (option.longName() != null && optionName.equals("--" + option.longName())
|| option.shortName() != ' ' && optionName.equals("-" + option.shortName())) {
return option;
}
}
return null;
}

}