feat(lists): add optional space indentation for list items (#13)

catcombo · Dec 10, 2022 · 2b46327 · 2b46327
2 parents 8146051 + 0b90199
commit 2b46327
Show file tree

Hide file tree

Showing 4 changed files with 78 additions and 48 deletions.
diff --git a/jira2markdown/markup/lists.py b/jira2markdown/markup/lists.py
@@ -1,3 +1,5 @@
+import re
+
 from pyparsing import (
     Char,
     Combine,
@@ -9,10 +11,10 @@
     Optional,
     ParserElement,
     ParseResults,
+    Regex,
     SkipTo,
     StringEnd,
     Token,
-    White,
 )
 
 from jira2markdown.markup.advanced import Panel
@@ -87,14 +89,22 @@ def action(self, tokens: ParseResults) -> str:
 
     @property
     def expr(self) -> ParserElement:
-        NL = LineEnd()
-        LIST_BREAK = NL + Optional(White(" \t")) + NL | StringEnd()
+        WHITESPACE = Regex(r"[ \t]+", flags=re.UNICODE)
+        EOL = LineEnd()
+        LIST_BREAK = EOL + Optional(WHITESPACE) + EOL | StringEnd()
         IGNORE = BlockQuote(**self.init_kwargs).expr | Panel(**self.init_kwargs).expr | Color(**self.init_kwargs).expr
-        ROW = LineStart() + Combine(
-            Optional(self.nested_token, default="")
-            + ListIndent(self.indent_state, self.tokens)
-            + SkipTo(NL + Char(self.nested_token + self.tokens) | LIST_BREAK, ignore=IGNORE)
-            + Optional(NL),
+        ROW = (
+            LineStart()
+            + Optional(WHITESPACE).suppress()
+            + Combine(
+                Optional(self.nested_token, default="")
+                + ListIndent(self.indent_state, self.tokens)
+                + SkipTo(
+                    EOL + Optional(WHITESPACE) + Char(self.nested_token + self.tokens) | LIST_BREAK,
+                    ignore=IGNORE,
+                )
+                + Optional(EOL),
+            )
         )
 
         return OneOrMore(ROW, stop_on=LIST_BREAK).set_parse_action(self.action)

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "jira2markdown"
-version = "0.3"
+version = "0.3.1"
 description = "Convert text from JIRA markup to Markdown using parsing expression grammars"
 authors = ["Evgeniy Krysanov <evgeniy.krysanov@gmail.com>"]
 readme = "README.md"

diff --git a/tests/markup/test_lists.py b/tests/markup/test_lists.py
@@ -59,7 +59,7 @@ def test_mixed_bullets(self):
     def test_match_start_conditions(self):
         assert convert("* Item") == "- Item"
         assert convert("\n* Item") == "\n- Item"
-        assert convert("  * Item") == r"  \* Item"
+        assert convert("  * Item") == r"- Item"
 
     def test_multiline(self):
         assert (
@@ -169,6 +169,22 @@ def test_text_indent(self):
 """
         )
 
+    def test_list_indent(self):
+        assert (
+            convert(
+                """
+  * One
+      ** Two
+ ** Three
+"""
+            )
+            == """
+- One
+  - Two
+  - Three
+"""
+        )
+
 
 class TestOrderedList:
     def test_bullets(self):
@@ -282,3 +298,19 @@ def test_empty_list(self):
    1. 
         """
         )
+
+    def test_list_indent(self):
+        assert (
+            convert(
+                """
+  # One
+      ## Two
+ ## Three
+"""
+            )
+            == """
+1. One
+   1. Two
+   1. Three
+"""
+        )