RSPEC tag links for context when browsing recipes (#112)

* Link to RSPEC * Handle optional `S`
openrewrite · Apr 22, 2024 · 1b83a91 · 1b83a91
1 parent 50dac39
commit 1b83a91
Showing 1 changed file with 12 additions and 3 deletions.
diff --git a/src/main/kotlin/org/openrewrite/RecipeMarkdownGenerator.kt b/src/main/kotlin/org/openrewrite/RecipeMarkdownGenerator.kt
@@ -166,7 +166,10 @@ class RecipeMarkdownGenerator : Runnable {
             val docLink =
                 docBaseUrl + recipeDescriptor.name.lowercase(Locale.getDefault()).removePrefix("org.openrewrite.")
                     .replace('.', '/')
-                    .replace("$", "usd") // needed for refaster templates + gitbook as we have started using $ in our recipe descriptors :(
+                    .replace(
+                        "$",
+                        "usd"
+                    ) // needed for refaster templates + gitbook as we have started using $ in our recipe descriptors :(
 
             val recipeSource = recipeDescriptor.source.toString()
             var isImperative = true
@@ -777,7 +780,13 @@ class RecipeMarkdownGenerator : Runnable {
                 writeln("### Tags")
                 newLine()
                 for (tag in recipeDescriptor.tags) {
-                    writeln("* $tag")
+                    if (tag.lowercase().startsWith("rspec-s")) {
+                        writeln("* [$tag](https://sonarsource.github.io/rspec/#/rspec/${tag.substring(6)})")
+                    } else if (tag.lowercase().startsWith("rspec-")) {
+                        writeln("* [$tag](https://sonarsource.github.io/rspec/#/rspec/S${tag.substring(6)})")
+                    } else {
+                        writeln("* $tag")
+                    }
                 }
                 newLine()
             }
@@ -837,7 +846,7 @@ class RecipeMarkdownGenerator : Runnable {
                         "[${match.value}](/reference/method-patterns.md)"
                     }
                     // Add valid options to description
-                    if (option.valid?.isNotEmpty()?: false) {
+                    if (option.valid?.isNotEmpty() ?: false) {
                         description += " Valid options: " + option.valid?.joinToString { "`$it`" }
                     }
                     // Preserve table cell formatting for multiline examples