[DOXIA-753] Do not end lists with a blank line

Otherwise every nested list is implicitly "loose" instead of "tight"
apache · Oct 22, 2024 · f0a40a2 · f0a40a2
1 parent a299dec
commit f0a40a2
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 6 deletions.
diff --git a/...ia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownSink.java b/...ia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownSink.java
@@ -448,7 +448,7 @@ public void sectionTitle_(int level) {
 
     @Override
     public void list_() {
-        ensureBlankLine();
+        ensureBeginningOfLine();
     }
 
     @Override
@@ -476,7 +476,7 @@ public void numberedList(int numbering, SinkEventAttributes attributes) {
 
     @Override
     public void numberedList_() {
-        writeUnescaped(EOL);
+        ensureBeginningOfLine();
     }
 
     @Override

diff --git a/...odule-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownSinkTest.java b/...odule-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownSinkTest.java
@@ -157,12 +157,12 @@ protected String getFooterBlock() {
 
     /** {@inheritDoc} */
     protected String getListBlock(String item) {
-        return MarkdownMarkup.LIST_UNORDERED_ITEM_START_MARKUP + getEscapedText(item) + EOL + EOL;
+        return MarkdownMarkup.LIST_UNORDERED_ITEM_START_MARKUP + getEscapedText(item) + EOL;
     }
 
     /** {@inheritDoc} */
     protected String getNumberedListBlock(String item) {
-        return MarkdownMarkup.LIST_ORDERED_ITEM_START_MARKUP + getEscapedText(item) + EOL + EOL;
+        return MarkdownMarkup.LIST_ORDERED_ITEM_START_MARKUP + getEscapedText(item) + EOL;
     }
 
     /** {@inheritDoc} */
@@ -486,7 +486,6 @@ public void testNestedListWithBlockquotesParagraphsAndCode() {
 
         String expected = "- item1" + EOL
                 + "    - item1a" + EOL
-                + EOL
                 + "- " + EOL + EOL
                 + "    > blockquote" + EOL + EOL
                 + "- item3" + EOL
@@ -548,7 +547,7 @@ public void testMultilineVerbatimSourceAfterListItem() {
 
         String expected = "- Before" + EOL + EOL + MarkdownMarkup.INDENT + MarkdownMarkup.VERBATIM_START_MARKUP + EOL
                 + MarkdownMarkup.INDENT + "codeline1" + EOL + MarkdownMarkup.INDENT + "codeline2" + EOL
-                + MarkdownMarkup.INDENT + MarkdownMarkup.VERBATIM_END_MARKUP + EOL + EOL + "After" + EOL + EOL;
+                + MarkdownMarkup.INDENT + MarkdownMarkup.VERBATIM_END_MARKUP + EOL + EOL + "After" + EOL;
         assertEquals(expected, getSinkContent(), "Wrong verbatim!");
     }
 
@@ -570,4 +569,36 @@ public void testDefinitionListWithInlineStyles() {
                 + "<dd>prefix <code>code</code><em>suffix&lt;a&gt;test&lt;/a&gt;</em></dd>" + EOL + "</dl>" + EOL + EOL;
         assertEquals(expected, getSinkContent(), "Wrong heading after inline element!");
     }
+
+    @Test
+    public void testNestedListBeingTight() {
+        try (final Sink sink = getSink()) {
+            sink.list();
+            sink.listItem();
+            sink.text("item 1");
+            sink.listItem_();
+            sink.listItem();
+            sink.text("item 2");
+            sink.list();
+            sink.listItem();
+            sink.text("item 2 a");
+            sink.listItem_();
+            sink.listItem();
+            sink.text("item 2 b");
+            sink.listItem_();
+            sink.list_();
+            sink.listItem_();
+            sink.list_();
+            sink.listItem();
+            sink.text("item 3");
+            sink.listItem_();
+            sink.list();
+        }
+        String expected = "- item 1" + EOL
+                + "- item 2" + EOL
+                + "    - item 2 a" + EOL
+                + "    - item 2 b" + EOL
+                + "- item 3" + EOL;
+        assertEquals(expected, getSinkContent());
+    }
 }