Skip to content

Fix inverted SYNOPSIS brackets in help output #1384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ezeprimo wants to merge 1 commit into from
+10 −10
Closed

Fix inverted SYNOPSIS brackets in help output #1384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...-shell-core/src/main/java/org/springframework/shell/core/command/CommandHelpRenderer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ private static void appendSynopsis(Command command, StringBuilder helpMessageBui
if (!options.isEmpty()) {
for (CommandOption option : options) {
helpMessageBuilder.append(" ");
if (isRequired(option)) {
if (!isRequired(option)) {
helpMessageBuilder.append("[");
}
if (option.longName() != null) {
Expand All @@ -92,7 +92,7 @@ private static void appendSynopsis(Command command, StringBuilder helpMessageBui
helpMessageBuilder.append("-").append(option.shortName());
}
helpMessageBuilder.append(" ").append(option.type().getSimpleName());
if (isRequired(option)) {
if (!isRequired(option)) {
helpMessageBuilder.append("]");
}
}
Expand Down
4 changes: 2 additions & 2 deletions ...l-core/src/test/java/org/springframework/shell/core/command/CommandHelpRendererTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ void testRenderHelpWithRequiredAndOptionalOptions() {
This command says hi to the user.

SYNOPSIS
hi [--name String] --times int --help
hi --name String [--times int] --help

OPTIONS
--name or -n String
Expand Down Expand Up @@ -173,7 +173,7 @@ void testRenderHelpWithOptionalOptionMissingDefaultValueUsesPrimitiveDefault() {
hi - Say hi

SYNOPSIS
hi --times int --help
hi [--times int] --help

OPTIONS
--times or -t int
Expand Down
12 changes: 6 additions & 6 deletions spring-shell-core/src/test/java/org/springframework/shell/core/command/HelpTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ void testHelpMessageForCommand() throws Exception {
This command says hi to the user.

SYNOPSIS
hi [--name String] --times int --help
hi --name String [--times int] --help

OPTIONS
--name or -n String
Expand Down Expand Up @@ -185,7 +185,7 @@ void testHelpMessageForCommandWithArgs() throws Exception {
This command says hi to the user.

SYNOPSIS
hi --times int [(String)] [(String)] --help
hi [--times int] [(String)] [(String)] --help

OPTIONS
--times or -t int
Expand Down Expand Up @@ -259,7 +259,7 @@ void testHelpMessageForCommandWithVariadicArgs() throws Exception {
This command says hi to the user.

SYNOPSIS
hi --name String (Integer...) --help
hi [--name String] (Integer...) --help

OPTIONS
--name String
Expand Down Expand Up @@ -339,7 +339,7 @@ void testSynopsisSpaceBetweenNonRequiredOptions() throws Exception {
This command says hi to the user.

SYNOPSIS
hi [--name String] --times int --suffix String --help
hi --name String [--times int] [--suffix String] --help

OPTIONS
--name or -n String
Expand Down Expand Up @@ -416,7 +416,7 @@ void testHelpMessageForCommandAlias() throws Exception {
This command says hi to the user.

SYNOPSIS
hi [--name String] --times int --help
hi --name String [--times int] --help

OPTIONS
--name or -n String
Expand Down Expand Up @@ -478,7 +478,7 @@ void testHelpMessageForCommandWithoutHelpText() throws Exception {
hi - Say hi

SYNOPSIS
hi [--name String] --help
hi --name String --help

OPTIONS
--name or -n String
Expand Down