Prevent invalid markdown when JavaDoc ends in source block

openrewrite · Feb 8, 2025 · bb90157 · bb90157
1 parent 350db92
commit bb90157
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/src/main/java/org/openrewrite/java/template/processor/RefasterTemplateProcessor.java b/src/main/java/org/openrewrite/java/template/processor/RefasterTemplateProcessor.java
@@ -506,6 +506,9 @@ private String recipeDescriptor(JCTree.JCClassDecl classDecl, String defaultDisp
                         displayName = firstLine;
                         description = new StringBuilder(lines[1].trim().replace("\n", "\\n"));
                         if (!description.toString().endsWith(".")) {
+                            if (description.toString().endsWith("```")) {
+                                description.append("\\n");
+                            }
                             description.append('.');
                         }
                     }
@@ -538,7 +541,7 @@ private String recipeDescriptor(JCTree.JCClassDecl classDecl, String defaultDisp
                         break;
                     } else if ("tech.picnic.errorprone.refaster.annotation.OnlineDocumentation".equals(annotationFqn)) {
                         if (annotation.getArguments().isEmpty()) {
-                            description.append(" [Source](https://error-prone.picnic.tech/refasterrules/").append(classDecl.name.toString()).append(").");
+                            description.append("\\n[Source](https://error-prone.picnic.tech/refasterrules/").append(classDecl.name.toString()).append(").");
                         }
                     }
                 }

diff --git a/src/test/resources/refaster/PicnicRulesRecipes.java b/src/test/resources/refaster/PicnicRulesRecipes.java
@@ -52,7 +52,7 @@ public String getDisplayName() {
 
     @Override
     public String getDescription() {
-        return "Picnic rules for refaster, showing how JavaDoc is converted to Markdown [Source](https://error-prone.picnic.tech/refasterrules/PicnicRules).";
+        return "Picnic rules for refaster, showing how JavaDoc is converted to Markdown\n[Source](https://error-prone.picnic.tech/refasterrules/PicnicRules).";
     }
 
     @Override