Completion for options and option values is not working

[czpilar]

This is regression from 4.0.0-M1.

4.0.0-M1

Consider configuration for 4.0.0-M1:

@SpringBootApplication
@CommandScan
@Command
public class SpringShellApplication {

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

	@Command(command = "hello")
	public void hello(@Option(longNames = "name") @OptionValues(provider = "helloNameCompletionProvider") String name) {
		System.out.println("Hello " + name + "!");
	}

	@Bean
	public CompletionProvider helloNameCompletionProvider() {
		return completionContext -> Stream.of("Peter", "Paul", "Mary").map(CompletionProposal::new).toList();
	}

}

Steps to reproduce:

1. Write hello and press tab
2. List of options is displayed
3. Select --name and press tab
4. List of completion proposals is displayed

4.0.0-RC1

Now have the same configuration for 4.0.0-RC1:

@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 = "name") String name) {
		System.out.println("Hello " + name + "!");
	}

	@Bean
	public CompletionProvider helloNameCompletionProvider() {
		return completionContext -> Stream.of("Peter", "Paul", "Mary").map(CompletionProposal::new).toList();
	}

}

Steps to reproduce:

1. Write hello and press tab
2. List of options should be displayed but command proposals are displayed instead

Steps to reproduce:

1. Write hello --name and press tab
2. List of option proposals should be displayed but command proposals are displayed instead

[czpilar]

The completion of options can be solved by following configuration but IMHO this is not optimal solution. It should probably work similiar way as in M1.

@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 = "name") String name) {
		System.out.println("Hello " + name + "!");
	}

	@Bean
	public CompletionProvider helloNameCompletionProvider() {
		return completionContext -> Stream.of("--name=Peter", "--name=Paul", "--name=Mary")
			.map(CompletionProposal::new)
			.toList();
	}

}

[fmbenhassine]

Thank you for opening this issue. I confirm that completion for command options does not work. I will fix that.

However, the approach in 4.0-M1 which is the same as v3 (I did not work on options yet at the time of 4.0-M1) is not optimal. First, it requires an additional annotation (@OptionValues) while we can customize completions with an attribute (see design simplification in v4 here). Moreover, one has to define several CompletionProvider beans if we have several options. And also that approach makes it impossible to combine completion providers.

Spring Shell should provide commands and options completion by default, and allow for completion customisation at command level with an attribute (which I believe is simpler, yet provide the same flexibility as the combination of OptionValues, OptionNameModifier, etc).

[czpilar]

@fmbenhassine Thank you for your work — you are absolutely right. I’ve been trying to upgrade to version 4.0 in our company project since the first milestone and discovered that completion does not work in RC1 either. So I tried to help by investigating and addressing some of the issues.