Fix formatting for multiline examples (#106)

openrewrite · Mar 15, 2024 · b4bf6a8 · b4bf6a8
1 parent c88bb6e
commit b4bf6a8
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/src/main/kotlin/org/openrewrite/RecipeMarkdownGenerator.kt b/src/main/kotlin/org/openrewrite/RecipeMarkdownGenerator.kt
@@ -840,7 +840,16 @@ class RecipeMarkdownGenerator : Runnable {
                     if (option.valid?.isNotEmpty()?: false) {
                         description += " Valid options: " + option.valid?.joinToString { "`$it`" }
                     }
-                    val example = if (option.example != null) "`${option.example}`" else ""
+                    // Preserve table cell formatting for multiline examples
+                    val example = if (option.example != null) {
+                        if (option.example.contains("\n")) {
+                            "<pre>${option.example.replace("<", "\\<")}</pre>".replace("\n", "<br />")
+                        } else {
+                            "`${option.example}`"
+                        }
+                    } else {
+                        ""
+                    }
                     writeln(
                         """
                         | `${option.type}` | ${option.name} | $description | $example |