feat(parser/renderer): support checklists (#262)

fixes #244 Signed-off-by: Xavier Coulon <[email protected]>
bytesparadise · Jan 6, 2019 · 34598af · 34598af
1 parent 3b97140
commit 34598af
Show file tree

Hide file tree

Showing 10 changed files with 9,890 additions and 9,215 deletions.
diff --git a/pkg/parser/asciidoc-grammar.peg b/pkg/parser/asciidoc-grammar.peg
@@ -526,8 +526,8 @@ OrderedListItemContent <- elements:(ListParagraph+ ContinuedDocumentElement*) {
 // ------------------------------------------
 // Unordered List Items
 // ------------------------------------------
-UnorderedListItem <- prefix:(UnorderedListItemPrefix) content:(UnorderedListItemContent) BlankLine* {
-    return types.NewUnorderedListItem(prefix.(types.UnorderedListItemPrefix), content.([]interface{}))
+UnorderedListItem <- prefix:(UnorderedListItemPrefix) checkstyle:(UnorderedListItemCheckStyle)? content:(UnorderedListItemContent) BlankLine* {
+    return types.NewUnorderedListItem(prefix.(types.UnorderedListItemPrefix), checkstyle, content.([]interface{}))
 }
 
 UnorderedListItemPrefix <- 
@@ -553,6 +553,14 @@ UnorderedListItemPrefix <-
             return prefix, nil
 } 
 
+UnorderedListItemCheckStyle <- &"[" style:(
+      "[ ]" { return types.Unchecked, nil } 
+    / "[*]" { return types.Checked, nil } 
+    / "[x]" { return types.Checked, nil }
+    ) WS+ {
+        return style, nil
+    }
+
 UnorderedListItemContent <- elements:(ListParagraph+ ContinuedDocumentElement*) { // Another list or a literal paragraph immediately following a list item will be implicitly included in the list item
     return types.NewListItemContent(elements.([]interface{}))
 } 

diff --git a/pkg/parser/asciidoc_parser.go b/pkg/parser/asciidoc_parser.go
diff --git a/pkg/parser/delimited_block_test.go b/pkg/parser/delimited_block_test.go
@@ -531,6 +531,7 @@ with *bold content*
 								Attributes:  types.ElementAttributes{},
 								Level:       1,
 								BulletStyle: types.OneAsterisk,
+								CheckStyle:  types.NoCheck,
 								Elements: []interface{}{
 									types.Paragraph{
 										Attributes: types.ElementAttributes{},
@@ -749,6 +750,7 @@ ____
 								Attributes:  types.ElementAttributes{},
 								Level:       1,
 								BulletStyle: types.Dash,
+								CheckStyle:  types.NoCheck,
 								Elements: []interface{}{
 									types.Paragraph{
 										Attributes: types.ElementAttributes{},
@@ -766,6 +768,7 @@ ____
 								Attributes:  types.ElementAttributes{},
 								Level:       1,
 								BulletStyle: types.Dash,
+								CheckStyle:  types.NoCheck,
 								Elements: []interface{}{
 									types.Paragraph{
 										Attributes: types.ElementAttributes{},
@@ -783,6 +786,7 @@ ____
 								Attributes:  types.ElementAttributes{},
 								Level:       1,
 								BulletStyle: types.Dash,
+								CheckStyle:  types.NoCheck,
 								Elements: []interface{}{
 									types.Paragraph{
 										Attributes: types.ElementAttributes{},
@@ -854,6 +858,7 @@ ____`
 								Attributes:  types.ElementAttributes{},
 								Level:       1,
 								BulletStyle: types.OneAsterisk,
+								CheckStyle:  types.NoCheck,
 								Elements: []interface{}{
 									types.Paragraph{
 										Attributes: types.ElementAttributes{},
@@ -893,6 +898,7 @@ ____`
 								Attributes:  types.ElementAttributes{},
 								Level:       1,
 								BulletStyle: types.OneAsterisk,
+								CheckStyle:  types.NoCheck,
 								Elements: []interface{}{
 									types.Paragraph{
 										Attributes: types.ElementAttributes{},
@@ -938,6 +944,7 @@ ____`
 								Attributes:  types.ElementAttributes{},
 								Level:       1,
 								BulletStyle: types.OneAsterisk,
+								CheckStyle:  types.NoCheck,
 								Elements: []interface{}{
 									types.Paragraph{
 										Attributes: types.ElementAttributes{},
@@ -955,6 +962,7 @@ ____`
 								Attributes:  types.ElementAttributes{},
 								Level:       1,
 								BulletStyle: types.OneAsterisk,
+								CheckStyle:  types.NoCheck,
 								Elements: []interface{}{
 									types.Paragraph{
 										Attributes: types.ElementAttributes{},
@@ -972,6 +980,7 @@ ____`
 								Attributes:  types.ElementAttributes{},
 								Level:       1,
 								BulletStyle: types.OneAsterisk,
+								CheckStyle:  types.NoCheck,
 								Elements: []interface{}{
 									types.Paragraph{
 										Attributes: types.ElementAttributes{},