doc: markdown allow empty lines in list

aya-prover · Dec 11, 2022 · e15eeff · e15eeff
1 parent a83f0e1
commit e15eeff
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 23 deletions.
diff --git a/pretty/src/main/java/org/aya/pretty/backend/md/DocMdPrinter.java b/pretty/src/main/java/org/aya/pretty/backend/md/DocMdPrinter.java
@@ -65,8 +65,7 @@ public class DocMdPrinter extends DocHtmlPrinter<DocMdPrinter.Config> {
   }
 
   @Override protected void renderHardLineBreak(@NotNull Cursor cursor, EnumSet<Outer> outer) {
-    if (outer.contains(Outer.List)) cursor.lineBreakWith("<br/>\n");
-    else cursor.lineBreakWith("\n");
+    cursor.lineBreakWith("\n");
   }
 
   @Override

diff --git a/pretty/src/main/java/org/aya/pretty/backend/string/Cursor.java b/pretty/src/main/java/org/aya/pretty/backend/string/Cursor.java
@@ -49,10 +49,9 @@ private void checkLineStart() {
     }
   }
 
-  /** New line if needed */
-  public void lineBreakIfNeeded(@NotNull CharSequence lineBreak) {
-    if (!isAtLineStart())
-      lineBreakWith(lineBreak);
+  /** Do something when I am not at line start. */
+  public void whenLineUsed(@NotNull Runnable runnable) {
+    if (!isAtLineStart()) runnable.run();
   }
 
   public void lineBreakWith(@NotNull CharSequence lineBreak) {

diff --git a/pretty/src/main/java/org/aya/pretty/backend/string/StringPrinter.java b/pretty/src/main/java/org/aya/pretty/backend/string/StringPrinter.java
@@ -185,12 +185,13 @@ protected void renderList(@NotNull Cursor cursor, @NotNull Doc.List list, EnumSe
   }
 
   protected static void renderList(@NotNull StringPrinter<?> printer, @NotNull Cursor cursor, @NotNull Doc.List list, EnumSet<Outer> outer) {
+    // TODO[kiva]: improve this!
     var isTopLevel = !outer.contains(Outer.List);
-    cursor.lineBreakIfNeeded("\n");
+    cursor.whenLineUsed(() -> printer.renderHardLineBreak(cursor, outer));
     if (isTopLevel) printer.renderHardLineBreak(cursor, outer);
 
     list.items().forEachIndexed((idx, item) -> {
-      cursor.lineBreakIfNeeded("\n");
+      cursor.whenLineUsed(() -> printer.renderHardLineBreak(cursor, outer));
 
       var pre = list.isOrdered()
         ? (idx + 1) + "."
@@ -206,7 +207,7 @@ protected static void renderList(@NotNull StringPrinter<?> printer, @NotNull Cur
     });
 
     if (isTopLevel) {
-      cursor.lineBreakIfNeeded("\n");
+      cursor.whenLineUsed(() -> printer.renderHardLineBreak(cursor, outer));
       printer.renderHardLineBreak(cursor, outer);
     }
   }

diff --git a/pretty/src/test/java/org/aya/pretty/MdStyleTest.java b/pretty/src/test/java/org/aya/pretty/MdStyleTest.java
@@ -111,32 +111,26 @@ public void testEscapeDocs() {
 
   @Test
   public void testList() {
-    var actual0 = bulletList().renderToMd();
-    var expected0 = """
+    assertEquals("""
             
-      + first<br/>
-        <br/>
+      + first
+        
         third
       + fourth
         + 4.1
         + 4.2
             
-      """;
+      """.stripIndent(), bulletList().renderToMd().stripIndent());
+    assertEquals("""
+
+      1. first
 
-    var actual1 = orderedList().renderToMd();
-    var expected1 = """
-            
-      1. first<br/>
-         <br/>
          third
       2. fourth
          + 4.1
          + 4.2
-            
-      """;
 
-    assertEquals(expected0, actual0);
-    assertEquals(expected1, actual1);
+      """.stripIndent(), orderedList().renderToMd().stripIndent());
   }
 
   @NotNull private Doc bulletList() {