Merge pull request #1250 from tomtheisen/gfm-tasks

GFM compliance for tasks lists
markedjs · May 8, 2018 · 42c3915 · 42c3915
2 parents e0434b1 + b083a1a
commit 42c3915
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 4 deletions.
diff --git a/lib/marked.js b/lib/marked.js
@@ -195,7 +195,9 @@ Lexer.prototype.token = function(src, top) {
       i,
       tag,
       l,
-      isordered;
+      isordered,
+      istask,
+      ischecked;
 
   while (src) {
     // newline
@@ -363,10 +365,20 @@ Lexer.prototype.token = function(src, top) {
           if (!loose) loose = next;
         }
 
+        // Check for task list items
+        istask = /^\[[ xX]\] /.test(item);
+        ischecked = undefined;
+        if (istask) {
+          ischecked = item[1] !== ' ';
+          item = item.replace(/^\[[ xX]\] +/, '');
+        }
+
         this.tokens.push({
           type: loose
             ? 'loose_item_start'
-            : 'list_item_start'
+            : 'list_item_start',
+          task: istask,
+          checked: ischecked
         });
 
         // Recurse.
@@ -927,6 +939,14 @@ Renderer.prototype.listitem = function(text) {
   return '<li>' + text + '</li>\n';
 };
 
+Renderer.prototype.checkbox = function(checked) {
+  return '<input '
+    + (checked ? 'checked="" ' : '')
+    + 'disabled="" type="checkbox"'
+    + (this.options.xhtml ? ' /' : '')
+    + '> ';
+}
+
 Renderer.prototype.paragraph = function(text) {
   return '<p>' + text + '</p>\n';
 };
@@ -1198,6 +1218,10 @@ Parser.prototype.tok = function() {
     case 'list_item_start': {
       body = '';
 
+      if (this.token.task) {
+        body += this.renderer.checkbox(this.token.checked);
+      }
+
       while (this.next().type !== 'list_item_end') {
         body += this.token.type === 'text'
           ? this.parseText()

diff --git a/test/specs/gfm/gfm-spec.js b/test/specs/gfm/gfm-spec.js
@@ -15,7 +15,7 @@ Messenger.prototype.test = function(spec, section, ignore) {
     var shouldFail = ~ignore.indexOf(spec.example);
     it('should ' + (shouldFail ? 'fail' : 'pass') + ' example ' + spec.example, function() {
       var expected = spec.html;
-      var actual = marked(spec.markdown, { headerIds: false, xhtml: true });
+      var actual = marked(spec.markdown, { headerIds: false, xhtml: false });
       since(messenger.message(spec, expected, actual)).expect(
         htmlDiffer.isEqual(expected, actual)
       ).toEqual(!shouldFail);
@@ -42,7 +42,7 @@ describe('GFM 0.28 Tables', function() {
 describe('GFM 0.28 Task list items', function() {
   var section = 'Task list items';
 
-  var shouldPassButFails = [272, 273];
+  var shouldPassButFails = [];
 
   var willNotBeAttemptedByCoreTeam = [];