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

4
spring-shell-standard-commands/src/main/java/org/springframework/shell/standard/commands/Help.java
View File

@@ -127,7 +127,7 @@ public class Help extends AbstractShellComponent {
List<ParameterDescription> parameterDescriptions = getParameterDescriptions(registration);
// NAME
documentCommandName(result, command, registration.getHelp());
documentCommandName(result, command, registration.getDescription());
// SYNOPSYS
documentSynopsys(result, command, parameterDescriptions);
@@ -300,7 +300,7 @@ public class Help extends AbstractShellComponent {
.append(prefix)
.append(String.join(", ", e.getValue()), AttributedStyle.BOLD)
.append(": ")
.append(e.getKey().getHelp())
.append(e.getKey().getDescription())
.append('\n');
});
if (showGroups) {

12
spring-shell-standard-commands/src/test/java/org/springframework/shell/standard/commands/HelpTests.java
View File

@@ -91,7 +91,7 @@ public class HelpTests {
public void testCommandHelp() throws Exception {
CommandRegistration registration = CommandRegistration.builder()
.command("first-command")
.help("A rather extensive description of some command.")
.description("A rather extensive description of some command.")
.withTarget()
.method(commandsPojo, "firstCommand")
.and()
@@ -127,7 +127,7 @@ public class HelpTests {
public void testCommandList() throws Exception {
CommandRegistration registration1 = CommandRegistration.builder()
.command("first-command")
.help("A rather extensive description of some command.")
.description("A rather extensive description of some command.")
.withTarget()
.method(commandsPojo, "firstCommand")
.and()
@@ -140,7 +140,7 @@ public class HelpTests {
CommandRegistration registration2 = CommandRegistration.builder()
.command("second-command")
.help("The second command. This one is known under several aliases as well.")
.description("The second command. This one is known under several aliases as well.")
.withTarget()
.method(commandsPojo, "secondCommand")
.and()
@@ -150,7 +150,7 @@ public class HelpTests {
CommandRegistration registration3 = CommandRegistration.builder()
.command("second-command")
.help("The last command.")
.description("The last command.")
.withTarget()
.method(commandsPojo, "thirdCommand")
.and()
@@ -159,7 +159,7 @@ public class HelpTests {
CommandRegistration registration4 = CommandRegistration.builder()
.command("first-group-command")
.help("The first command in a separate group.")
.description("The first command in a separate group.")
.group("Example Group")
.withTarget()
.method(commandsPojo, "firstCommandInGroup")
@@ -169,7 +169,7 @@ public class HelpTests {
CommandRegistration registration5 = CommandRegistration.builder()
.command("second-group-command")
.help("The second command in a separate group.")
.description("The second command in a separate group.")
.group("Example Group")
.withTarget()
.method(commandsPojo, "secondCommandInGroup")