Only print yaml options if required or has example

openrewrite · Dec 13, 2023 · beaabd1 · beaabd1
1 parent f17d59b
commit beaabd1
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/main/kotlin/org/openrewrite/RecipeMarkdownGenerator.kt b/src/main/kotlin/org/openrewrite/RecipeMarkdownGenerator.kt
@@ -1043,6 +1043,9 @@ class RecipeMarkdownGenerator : Runnable {
                 """.trimIndent()
                 )
                 for (option in recipeDescriptor.options) {
+                    if (!option.isRequired && option.example == null) {
+                        continue
+                    }
                     val ex = if (option.example != null && "String" == option.type
                         && (option.example.matches("^[{}\\[\\],`|=%@*!?-].*".toRegex())
                                 || option.example.matches(".*:\\s.*".toRegex()))