Consistently escape recipe.displayName (#204)

* Consistently escape recipe.displayName

* Use the same escape everywhere

* Remove enum

* Also escape description as needed

* Consistently format lists of recipes in condensed format

* Minor fixes as seen in render

* Fix parse issue with recipeDescriptors.yml

* Group by artifactId

* Final touches

Author: timtebeek

build.gradle.kts

@@ -167,7 +167,6 @@ tasks.named<JavaExec>("run").configure {
         // Additional modules whose versions we want to show, but not (yet) their recipes
         dependencies {
             "recipe"("org.openrewrite:rewrite-cobol:$rewriteVersion")
-            "recipe"("org.openrewrite:rewrite-csharp:$rewriteVersion")
             "recipe"("org.openrewrite:rewrite-javascript:$rewriteVersion")
             "recipe"("org.openrewrite:rewrite-polyglot:$rewriteVersion")
             "recipe"("org.openrewrite:rewrite-python:$rewriteVersion")

src/main/kotlin/org/openrewrite/RecipeDescriptorExtensions.kt

@@ -3,15 +3,35 @@ package org.openrewrite
 import org.openrewrite.config.OptionDescriptor
 import org.openrewrite.config.RecipeDescriptor
 
+fun RecipeDescriptor.displayNameEscaped(): String {
+    return escape(displayName)
+        // Always remove URLs in markdown format [text](url)
+        .replace(Regex("\\[([^]]+)]\\([^)]+\\)"), "$1")
+}
+fun RecipeDescriptor.descriptionEscaped(): String {
+    if (description.isNullOrBlank()) {
+        return ""
+    }
+    return escape(description)
+        .replace("\n", " ")
+        .trim()
+}
+private fun escape(string: String): String = string
+    .replace("&", "&")
+    .replace("<", "&lt;")
+    .replace(">", "&gt;")
+    .replace("\"", "&quot;")
+    .replace("'", "&#39;")
+
 fun RecipeDescriptor.asYaml(): String {
     val s = StringBuilder()
     s.appendLine("""
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: $name
-displayName: $displayName
+displayName: ${displayNameEscaped()}
 description: |
-  ${description?.replace("\n", "\n  ")?.replace("```. [Source]", "```\n  [Source]") ?: ""}
+  ${descriptionEscaped()}
     """.trimIndent())
     if (tags.isNotEmpty()) {
         s.appendLine("tags:")