Show valid options in a list

openrewrite · Dec 13, 2023 · c65ebf6 · c65ebf6
1 parent beaabd1
commit c65ebf6
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/main/kotlin/org/openrewrite/RecipeMarkdownGenerator.kt b/src/main/kotlin/org/openrewrite/RecipeMarkdownGenerator.kt
@@ -835,6 +835,13 @@ class RecipeMarkdownGenerator : Runnable {
                     description = description.replace("method patterns?".toRegex(RegexOption.IGNORE_CASE)) { match ->
                         "[${match.value}](/reference/method-patterns.md)"
                     }
+                    // Add valid options to description
+                    if (option.valid != null && option.valid.isNotEmpty()) {
+                        description += "\n\nValid options:\n"
+                        option.valid.forEach { validOption ->
+                            description += "* `$validOption`\n"
+                        }
+                    }
                     writeln(
                             """
                         | `${option.type}` | ${option.name} | $description | `${option.example}` |