Missng arguments(!) info in help message of commands

[tschoellhorn]

This is an addition to the already closed issue #1344 :

I use the current version of spring-shell 4.0.3. It seems that the issue 1344 has been resolved but I miss the documentation for @arguments. Look at the following example:

@CommandGroup(name = "samples", prefix = "samples")
@Component
public class SampleCommand {

	@Command(
		name = "foo", 
		description = "Description of 'foo'", 
		help = "Help of 'foo'")
	public void foo(
		@Argument(index = 0, description = "The desc of value") int value, 
		@Option String name) {
		System.out.println("do it : " + name);
		System.out.println("value: " + value);
	}
	
	@Command(
		name = "bar", 
		description = "Description of 'bar'", 
		help = "Help of 'bar'")
	public void bar(
		@Arguments List<Integer> values, 
		@Option String name) {
		System.out.println("do it : " + name);
		System.out.println("values: " + values);
	}	
}

When I now call help samples bar the output of the help message does not mention anything about its arguments:

NAME
        samples bar - Description of 'var'

SYNOPSIS
        samples bar --name String --help

OPTIONS
        --name String

        [Optional, default = ]

        --help or -h
        help for samples bar
        [Optional]

It seems that the @Arguments-Annotation does not have an "description" and that the information about @arguments is completely ignored in the help-output.

[czpilar]

The @Arguments annotation is never turned into command metadata - getCommandArguments() in CommandFactoryBean only reads @Argument. Help then has nothing to render, so both the SYNOPSIS entry and the ARGUMENTS section are skipped. The annotation also had no description() attribute to begin with.

Reproducer:

@Command(name = "foo", description = "Description of 'foo'", help = "Help of 'foo'")
public void foo(@Argument(index = 0, description = "The desc of value") int value, @Option String name) {
	System.out.println("value: " + value);
}

@Command(name = "bar", description = "Description of 'bar'", help = "Help of 'bar'")
public void bar(@Arguments(description = "The values to sum up") List<Integer> values, @Option String name) {
	System.out.println("values: " + values);
}

help foo documents its argument, help bar says nothing about its own.

I've fixed it by adding description() to @Arguments, reporting it as a variadic CommandArgument carrying the element type resolved from the parameter's generics, and rendering it as (Integer...) / [Index 0...]. The element type matters - the declared parameter type is List, which would tell the user nothing.

Output with the fix applied:

Fixed in PR #1372