Skip to content

feat(command): show example values for parameters in help command #202

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

Open
Kronos279 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(command): show example values for parameters in help command #202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a35846a
feat(command): show example values for parameters in help command
Kronos279 May 4, 2026
ecc3550
fix(command): show all completion candidates in help descriptions
Kronos279 Jul 4, 2026
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
11 changes: 10 additions & 1 deletion src/main/java/com/seed4j/cli/command/infrastructure/primary/ApplyModuleSubCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,9 @@ private void addOptions(CommandSpec spec, Seed4JModulePropertiesDefinition prope
spec.addOption(
OptionSpec.builder(toDashedFormat(property.key()))
.description(
"%s%s".formatted(
"%s%s%s".formatted(
property.description().map(Seed4JPropertyDescription::get).orElse(""),
exampleValues(property),
property.isMandatory() ? " (required)" : ""
)
)
Expand All @@ -113,6 +114,14 @@ private List<String> completionCandidates(Seed4JModulePropertyDefinition propert
return knownCompletionCandidates.candidates(property);
}

private String exampleValues(Seed4JModulePropertyDefinition property) {
List<String> candidates = knownCompletionCandidates.candidates(property);
if (candidates.isEmpty()) {
return "";
}
return " e.g. " + String.join(", ", candidates);
}

@ExcludeFromGeneratedCodeCoverage(reason = "There is no Seed4J module using a property with the BOOLEAN type")
private static Class<?> toOptionType(Seed4JPropertyType type) {
return switch (type) {
Expand Down
21 changes: 19 additions & 2 deletions src/test/java/com/seed4j/cli/command/infrastructure/primary/Seed4JCommandsFactoryTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,8 +516,25 @@ void shouldNotApplyInitModuleMissingRequiredOptions(CapturedOutput output) throw
.contains("Missing required")
.contains("'--base-name=<basename*>'")
.contains("'--project-name=<projectname*>'")
.contains("Project short name (only letters and numbers) (required)")
.contains("Project full name (required)");
.contains("Project short name (only letters and numbers) e.g.")
.contains("seed4jSampleApplication (required)")
.contains("Project full name e.g. Seed4J Sample Application")
.contains("(required)");
}

@Test
void shouldShowExampleValuesInHelpDescription(CapturedOutput output) {
String[] args = { "apply", "init", "--help" };

int exitCode = commandLine(modules, projects).execute(args);

assertThat(exitCode).isZero();
assertThat(output)
.contains("Project short name (only letters and numbers) e.g.")
.contains("seed4jSampleApplication (required)")
.contains("Node package manager e.g. npm, pnpm (required)")
.contains("Project full name e.g. Seed4J Sample Application")
.contains("(required)");
}

@Test
Expand Down
Loading