Skip to content
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

improve command line help message format (DAT-12853) #3829

Merged
merged 12 commits into from
Feb 22, 2023
Merged

improve command line help message format (DAT-12853) #3829

Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e476c03
remove deprecated command line parameter format
StevenMassaro Feb 15, 2023
b5bc8ed
reformat property names
StevenMassaro Feb 15, 2023
c115d59
fill console width
StevenMassaro Feb 15, 2023
cfe1d85
remove deprecated line from global params
StevenMassaro Feb 16, 2023
11283ef
add defaults file/env var helper text to description for global args
StevenMassaro Feb 16, 2023
351a539
set auto width in pico using a better API
StevenMassaro Feb 16, 2023
2e02db6
remove unnecessary extra line break
StevenMassaro Feb 16, 2023
0ec5cc3
remove deprecated command names
StevenMassaro Feb 16, 2023
6f2bab3
Merge branch 'master' into DAT-12853
StevenMassaro Feb 16, 2023
e52e2d1
Merge branch 'master' into DAT-12853
StevenMassaro Feb 17, 2023
1520252
add newline space to help and version parameters
StevenMassaro Feb 20, 2023
d83fc2d
Merge branch 'master' into DAT-12853
StevenMassaro Feb 22, 2023
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
50 changes: 17 additions & 33 deletions liquibase-cli/src/main/java/liquibase/integration/commandline/LiquibaseCommandLine.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,8 @@ private CommandLine buildPicoCommandLine() {

commandLine.setExecutionExceptionHandler((ex, commandLine1, parseResult) -> LiquibaseCommandLine.this.handleException(ex));

commandLine.setUsageHelpAutoWidth(true);

return commandLine;
}

Expand Down Expand Up @@ -767,15 +769,9 @@ private void addSubcommand(CommandDefinition commandDefinition, CommandLine root
}

String shortDescription = commandDefinition.getShortDescription();
String displayDescription = shortDescription;
String legacyCommand = commandName[commandName.length - 1];
String camelCaseCommand = StringUtil.toCamelCase(legacyCommand);
if (!legacyCommand.equals(camelCaseCommand)) {
displayDescription = "\n" + shortDescription + "\n[deprecated: " + camelCaseCommand + "]";
}

subCommandSpec.usageMessage()
.header(StringUtil.trimToEmpty(displayDescription) + "\n")
.header(StringUtil.trimToEmpty(shortDescription) + "\n")
.description(StringUtil.trimToEmpty(commandDefinition.getLongDescription()));

subCommandSpec.optionsCaseInsensitive(true);
Expand All @@ -796,36 +792,32 @@ private void addSubcommand(CommandDefinition commandDefinition, CommandLine root

String argDisplaySuffix = "";
String argName = argNames[i];
String camelCaseArg = StringUtil.toCamelCase(argName.substring(2));
if (!argName.equals("--" + camelCaseArg)) {
argDisplaySuffix = "\n[deprecated: --" + camelCaseArg + "]";
}

//
// Determine if this is a group command and set the property/environment display strings accordingly
//
String description;
if (commandDefinition.getName().length > 1) {
String propertyStringToPresent = "\n(liquibase.command." +
StringUtil.join(commandDefinition.getName(), ".") + "." + def.getName() + ")";
String propertyStringToPresent = "\n(defaults file: 'liquibase.command." +
StringUtil.join(commandDefinition.getName(), ".") + "." + def.getName() + "'";
String envStringToPresent =
toEnvVariable("\n(liquibase.command." + StringUtil.join(commandDefinition.getName(), ".") +
"." + def.getName()) + ")" + argDisplaySuffix;
toEnvVariable("environment variable: 'liquibase.command." + StringUtil.join(commandDefinition.getName(), ".") +
"." + def.getName()) + "')" + argDisplaySuffix;
description = propertyStringToPresent + envStringToPresent;
} else {
description =
"\n(liquibase.command." + def.getName() + " OR liquibase.command." +
StringUtil.join(commandDefinition.getName(), ".") + "." + def.getName() + ")\n" +
"(" + toEnvVariable("liquibase.command." + def.getName()) + " OR " +
toEnvVariable("liquibase.command." + StringUtil.join(commandDefinition.getName(), ".") +
"." + def.getName()) + ")" + argDisplaySuffix;
String propertyStringToPresent = "\n(defaults file: 'liquibase.command." + def.getName() + "' OR 'liquibase.command." +
StringUtil.join(commandDefinition.getName(), ".") + "." + def.getName() + "'";
String envStringToPresent = ", environment variable: '" + toEnvVariable("liquibase.command." + def.getName()) + "' OR '" +
toEnvVariable("liquibase.command." + StringUtil.join(commandDefinition.getName(), ".") +
"." + def.getName()) + "')" + argDisplaySuffix;
description = propertyStringToPresent + envStringToPresent;
}

if (def.getDefaultValue() != null) {
if (def.getDefaultValueDescription() == null) {
description = "\nDEFAULT: " + def.getDefaultValue() + "\n" + description;
description = "\nDEFAULT: " + def.getDefaultValue() + description;
} else {
description = "\nDEFAULT: " + def.getDefaultValueDescription() + "\n" + description;
description = "\nDEFAULT: " + def.getDefaultValueDescription() + description;
}
}

Expand Down Expand Up @@ -995,8 +987,8 @@ private void addGlobalArguments(CommandLine commandLine) {
final CommandLine.Model.OptionSpec.Builder optionBuilder = CommandLine.Model.OptionSpec.builder(argNames[i])
.required(false)
.type(String.class);
String description = "(" + def.getKey() + ")\n"
+ "(" + toEnvVariable(def.getKey()) + ")";
String description = "(defaults file: '" + def.getKey() + "', environment variable: '"
+ toEnvVariable(def.getKey()) + "')";

if (def.getDefaultValue() != null) {
if (def.getDefaultValueDescription() == null) {
Expand All @@ -1009,14 +1001,6 @@ private void addGlobalArguments(CommandLine commandLine) {
if (def.getDescription() != null) {
description = def.getDescription() + "\n" + description;
}
if (i == 0) {
String primaryArg = argNames[i];
String camelCaseArg = StringUtil.toCamelCase(primaryArg.substring(2));
if (!primaryArg.equals("--" + camelCaseArg)) {
description = "\n" + description +
"\n[deprecated: --" + camelCaseArg + "]";
}
}

optionBuilder.description(description + "\n");

Expand Down