Improved completion for a specific command, including support for resolving key=value pairs in the command line

[czpilar]

Improved #1246

[czpilar]

I’ve just realized that after fixing the completion issue #1246, I completely missed the case where key=value is already present on the command line.

So if you already have shell:>hello --first=Mary on the line and press Tab, you will see the completion proposals for the --first and -f options again.

Consider the following example:

package org.springframework.shell.samples.helloworld.boot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.shell.core.command.CommandOption;
import org.springframework.shell.core.command.annotation.Command;
import org.springframework.shell.core.command.annotation.Option;
import org.springframework.shell.core.command.completion.CompletionProposal;
import org.springframework.shell.core.command.completion.CompletionProvider;

import java.util.Collections;
import java.util.stream.Stream;

@SpringBootApplication
public class SpringShellApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringShellApplication.class, args);
    }

    @Command(name = "hello", completionProvider = "helloNameCompletionProvider")
    public void sayHello(@Option(longName = "first", shortName = 'f') String first,
                         @Option(longName = "last", shortName = 'l') String last) {
        System.out.println("Hello " + first + " " + last + "!");
    }

    @Bean
    public CompletionProvider helloNameCompletionProvider() {
        return completionContext -> {
            CommandOption option = completionContext.getCommandOption();
            if (option == null) {
                return Collections.emptyList();
            }

            Stream<String> options = Stream.empty();

            if ("first".equals(option.longName())) {
                options = Stream.of("Peter", "Paul", "Mary");
            }
            else if ("last".equals(option.longName())) {
                options = Stream.of("Chan", "Noris");
            }

            return options.map(CompletionProposal::new).toList();
        };
    }

}

If you also want completion for the key=value pair, such as shell:>hello --first=, and then press Tab, it can be provided by the helloNameCompletionProvider as well.

Consider the following example:

package org.springframework.shell.samples.helloworld.boot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.shell.core.command.CommandOption;
import org.springframework.shell.core.command.annotation.Command;
import org.springframework.shell.core.command.annotation.Option;
import org.springframework.shell.core.command.completion.CompletionProposal;
import org.springframework.shell.core.command.completion.CompletionProvider;

import java.util.Collections;
import java.util.stream.Stream;

@SpringBootApplication
public class SpringShellApplication {

	public static void main(String[] args) {
		SpringApplication.run(SpringShellApplication.class, args);
	}

	@Command(name = "hello", completionProvider = "helloNameCompletionProvider")
	public void sayHello(@Option(longName = "first", shortName = 'f') String first,
			@Option(longName = "last", shortName = 'l') String last) {
		System.out.println("Hello " + first + " " + last + "!");
	}

	@Bean
	public CompletionProvider helloNameCompletionProvider() {
		return completionContext -> {
			CommandOption option = completionContext.getCommandOption();
			if (option == null) {
				return Collections.emptyList();
			}

			String word = completionContext.getWords().get(completionContext.getWords().size() - 1);
			if (word.contains("=")) {
				word = word.substring(0, word.indexOf('='));
			}
			String prefix = word.isEmpty() ? word : word + "=";

			Stream<String> options = Stream.empty();

			if ("first".equals(option.longName())) {
				options = Stream.of("Peter", "Paul", "Mary");
			}
			else if ("last".equals(option.longName())) {
				options = Stream.of("Chan", "Noris");
			}

			return options.map(str -> prefix + str).map(CompletionProposal::new).toList();
		};
	}

}

@fmbenhassine Also, it’s great that you improved the default command parser in #1248 - it now works very well with completion.

[czpilar]

Added tests for Command Completer.

[czpilar]

Added more tests.

[czpilar]

Added one more test for command with subcommand

[czpilar]

Added one more tests for completion with two options where one is subset of other

[fmbenhassine]

That's great! I am glad things are getting improved continuously.

Thank you very much for your PR 👍

[fmbenhassine]

If you also want completion for the key=value pair, such as shell:>hello --first=, and then press Tab, it can be provided by the helloNameCompletionProvider as well.

Thank you for sharing this example! Very useful for those who want to provide completion values with the --key=value notation. I am thinking about #285 here as well.

Rebased, squashed and merged as 8960cf4. Thank you for your contribution 🙏

[czpilar]

Thank you for sharing this example! Very useful for those who want to provide completion values with the --key=value notation. I am thinking about #285 here as well.

@fmbenhassine I can take a look at this. You can assign #285 to me... I will look at this later today or tomorrow.