Example for boolean parameters with default false should be setting i…

…t to true Friday fun 👋😀
gradlex-org · Sep 1, 2023 · 1050e72 · 1050e72
1 parent f661025
commit 1050e72
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/src/main/java/org/gradlex/buildparameters/Parameters.java b/src/main/java/org/gradlex/buildparameters/Parameters.java
@@ -79,7 +79,7 @@ private void printDetails(StyledTextOutput output) {
                 exampleValue = "42";
             } else if (parameter instanceof BooleanBuildParameter) {
                 type = "Boolean";
-                exampleValue = "false";
+                exampleValue = ((BooleanBuildParameter)parameter).getDefaultValue().map(v -> v ? "false" : "true").getOrElse("false");
             } else if (parameter instanceof EnumBuildParameter) {
                 type = "Enum";
                 exampleValue = ((EnumBuildParameter) parameter).getValues().get().get(0);

diff --git a/src/test/groovy/org/gradlex/buildparameters/ParametersTaskFuncTest.groovy b/src/test/groovy/org/gradlex/buildparameters/ParametersTaskFuncTest.groovy
@@ -122,7 +122,7 @@ class ParametersTaskFuncTest extends Specification {
         result.output.contains("Examples\n     -Pdeployment.dev.port=42")
     }
 
-    def "prints details for Boolean parameter"() {
+    def "prints details for Boolean parameter with a false default"() {
         when:
         def result = build(":build-logic:parameters", "--details", "ci")
 
@@ -131,7 +131,19 @@ class ParametersTaskFuncTest extends Specification {
         !result.output.contains("Description")
         result.output.contains("Default value\n     false")
         result.output.contains("Environment Variable\n     CI")
-        result.output.contains("Examples\n     -Pci\n     -Pci=false")
+        result.output.contains("Examples\n     -Pci\n     -Pci=true")
+    }
+
+    def "prints details for Boolean parameter with no default"() {
+        when:
+        def result = build(":build-logic:parameters", "--details", "local")
+
+        then:
+        result.output.contains("Type\n     Boolean")
+        !result.output.contains("Description")
+        result.output.contains("Default value\n     (none)")
+        result.output.contains("Environment Variable\n     LOCAL_RUN")
+        result.output.contains("Examples\n     -Plocal\n     -Plocal=false")
     }
 
     def "prints details for Enum parameter"() {