Spring/spring-shell
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Change help to description in command registration

Browse Source 
- Fixes #421
This commit is contained in:
Janne Valkealahti
2022-05-18 08:59:57 +01:00
parent c7d3eb15b4
commit baf8346063
10 changed files with 58 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
spring-shell-core/src/main/java/org/springframework/shell/Shell.java
View File

@@ -271,7 +271,7 @@ public class Shell {
return new CompletionProposal(command)
.dontQuote(true)
.category("Available commands")
.description(registration.getHelp());
.description(registration.getDescription());
}
/**

33
spring-shell-core/src/main/java/org/springframework/shell/command/CommandRegistration.java
View File

@@ -56,13 +56,6 @@ public interface CommandRegistration {
*/
InteractionMode getInteractionMode();
/**
* Get help for a command.
*
* @return the help
*/
String getHelp();
/**
* Get group for a command.
*
@@ -382,12 +375,12 @@ public interface CommandRegistration {
Builder interactionMode(InteractionMode mode);
/**
* Define a simple help text for a command.
* Define a description text for a command.
*
* @param help the help text
* @param help the description text
* @return builder for chaining
*/
Builder help(String help);
Builder description(String description);
/**
* Define an {@link Availability} suppliear for a command.
@@ -623,19 +616,17 @@ public interface CommandRegistration {
private String command;
private InteractionMode interactionMode;
private String help;
private String group;
private String description;
private Supplier<Availability> availability;
private List<DefaultOptionSpec> optionSpecs;
private DefaultTargetSpec targetSpec;
public DefaultCommandRegistration(String[] commands, InteractionMode interactionMode, String help,
String group, String description, Supplier<Availability> availability,
List<DefaultOptionSpec> optionSpecs, DefaultTargetSpec targetSpec) {
public DefaultCommandRegistration(String[] commands, InteractionMode interactionMode, String group,
String description, Supplier<Availability> availability, List<DefaultOptionSpec> optionSpecs,
DefaultTargetSpec targetSpec) {
this.command = commandArrayToName(commands);
this.interactionMode = interactionMode;
this.help = help;
this.group = group;
this.description = description;
this.availability = availability;
@@ -653,11 +644,6 @@ public interface CommandRegistration {
return interactionMode;
}
@Override
public String getHelp() {
return help;
}
@Override
public String getGroup() {
return group;
@@ -712,7 +698,6 @@ public interface CommandRegistration {
private String[] commands;
private InteractionMode interactionMode = InteractionMode.ALL;
private String help;
private String group;
private String description;
private Supplier<Availability> availability;
@@ -738,8 +723,8 @@ public interface CommandRegistration {
}
@Override
public Builder help(String help) {
this.help = help;
public Builder description(String description) {
this.description = description;
return this;
}
@@ -774,7 +759,7 @@ public interface CommandRegistration {
Assert.notNull(commands, "command cannot be empty");
Assert.notNull(targetSpec, "target cannot be empty");
Assert.state(!(targetSpec.bean != null && targetSpec.function != null), "only one target can exist");
return new DefaultCommandRegistration(commands, interactionMode, help, group, description, availability,
return new DefaultCommandRegistration(commands, interactionMode, group, description, availability,
optionSpecs, targetSpec);
}
}