fix(lists): fix github code blocks not being parsed inside lists

Fix ghCodeBlocks not being correctly parsed inside lists. Also, as a side
effect, fixes issues with consecutive lists and extra paragraphs being
added into lists.

Closes #142, Closes #183, Closes #184

package.json

@@ -1,6 +1,6 @@
 {
   "name": "showdown",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "A Markdown to HTML converter written in Javascript",
   "author": "Estevão Santos",
   "homepage": "http://showdownjs.github.io/showdown/",

src/subParsers/githubCodeBlocks.js

@@ -18,14 +18,8 @@ showdown.subParser('githubCodeBlocks', function (text, options, globals) {
 
   text += '~0';
 
-  text = text.replace(/(?:^|\n)```(.*)\n([\s\S]*?)\n```/g, function (wholeMatch, m1, m2) {
-    var language = m1,
-        codeblock = m2,
-        end = '\n';
-
-    if (options.omitExtraWLInCodeBlocks) {
-      end = '';
-    }
+  text = text.replace(/(?:^|\n)```(.*)\n([\s\S]*?)\n```/g, function (wholeMatch, language, codeblock) {
+    var end = (options.omitExtraWLInCodeBlocks) ? '' : '\n';
 
     codeblock = showdown.subParser('encodeCode')(codeblock);
     codeblock = showdown.subParser('detab')(codeblock);

src/subParsers/lists.js

@@ -4,15 +4,13 @@
 showdown.subParser('lists', function (text, options, globals) {
   'use strict';
 
-  var spl = '~1';
-
   /**
    * Process the contents of a single ordered or unordered list, splitting it
    * into individual list items.
    * @param {string} listStr
    * @returns {string}
    */
-  function processListItems (listStr) {
+  function processListItems (listStr, trimTrailing) {
     // The $g_list_level global keeps track of when we're inside a list.
     // Each time we enter a list, we increment it; when we leave a list,
     // we decrement. If it's zero, we're not in a list anymore.
@@ -33,7 +31,6 @@ showdown.subParser('lists', function (text, options, globals) {
     // without resorting to mind-reading. Perhaps the solution is to
     // change the syntax rules such that sub-lists must start with a
     // starting cardinal number; e.g. "1." or "a.".
-
     globals.gListLevel++;
 
     // trim trailing blank lines:
@@ -42,93 +39,96 @@ showdown.subParser('lists', function (text, options, globals) {
     // attacklab: add sentinel to emulate \z
     listStr += '~0';
 
-    var rgx = /(\n)?(^[ \t]*)([*+-]|\d+[.])[ \t]+((\[(x| )?])?[ \t]*[^\r]+?(\n{1,2}))(?=\n*(~0|\2([*+-]|\d+[.])[ \t]+))/gm;
+    var rgx = /(\n)?(^[ \t]*)([*+-]|\d+[.])[ \t]+((\[(x| )?])?[ \t]*[^\r]+?(\n{1,2}))(?=\n*(~0|\2([*+-]|\d+[.])[ \t]+))/gm,
+        isParagraphed = (/\n[ \t]*\n(?!~0)/.test(listStr));
 
     listStr = listStr.replace(rgx, function (wholeMatch, m1, m2, m3, m4, taskbtn, checked) {
       checked = (checked && checked.trim() !== '');
+      var item = showdown.subParser('outdent')(m4, options, globals),
+          bulletStyle = '';
 
-      var item = showdown.subParser('outdent')(m4, options, globals);
-
-      //m1 - LeadingLine
+      // Support for github tasklists
+      if (taskbtn && options.tasklists) {
+        bulletStyle = ' class="task-list-item" style="list-style-type: none;"';
+        item = item.replace(/^[ \t]*\[(x| )?]/m, function () {
+          var otp = '<input type="checkbox" disabled style="margin: 0px 0.35em 0.25em -1.6em; vertical-align: middle;"';
+          if (checked) {
+            otp += ' checked';
+          }
+          otp += '>';
+          return otp;
+        });
+      }
+      // m1 - Leading line or
+      // Has a double return (multi paragraph) or
+      // Has sublist
       if (m1 || (item.search(/\n{2,}/) > -1)) {
+        item = showdown.subParser('githubCodeBlocks')(item, options, globals);
         item = showdown.subParser('blockGamut')(item, options, globals);
       } else {
-        if (taskbtn && options.tasklists) {
-          item = item.replace(taskbtn, function () {
-            var otp = '<input type="checkbox" disabled style="margin: 0px 0.35em 0.25em -1.6em; vertical-align: middle;"';
-            if (checked) {
-              otp += ' checked';
-            }
-            otp += '>';
-            return otp;
-          });
-        }
-
         // Recursion for sub-lists:
         item = showdown.subParser('lists')(item, options, globals);
         item = item.replace(/\n$/, ''); // chomp(item)
-        item = showdown.subParser('spanGamut')(item, options, globals);
+        if (isParagraphed) {
+          item = showdown.subParser('paragraphs')(item, options, globals);
+        } else {
+          item = showdown.subParser('spanGamut')(item, options, globals);
+        }
       }
-
-      // this is a "hack" to differentiate between ordered and unordered lists
-      // related to issue #142
-      var tp = (m3.search(/[*+-]/g) > -1) ? 'ul' : 'ol',
-        bulletStyle = '';
-
-      if (taskbtn) {
-        bulletStyle = ' class="task-list-item" style="list-style-type: none;"';
-      }
-
-      return spl + tp + '<li' + bulletStyle + '>' + item + '</li>\n';
+      item =  '\n<li' + bulletStyle + '>' + item + '</li>\n';
+      return item;
     });
 
     // attacklab: strip sentinel
     listStr = listStr.replace(/~0/g, '');
 
     globals.gListLevel--;
+
+    if (trimTrailing) {
+      listStr = listStr.replace(/\s+$/, '');
+    }
+
     return listStr;
   }
 
   /**
-   * Slit consecutive ol/ul lists (related to issue 142)
-   * @param {Array} results
+   * Check and parse consecutive lists (better fix for issue #142)
+   * @param {string} list
    * @param {string} listType
-   * @returns {string|*}
+   * @returns {string}
    */
-  function splitConsecutiveLists (results, listType) {
-    // parsing html with regex...
-    // This will surely fail if some extension decides to change paragraph markup directly
-    var cthulhu = /(<p[^>]+?>|<p>|<\/p>)/img,
-        holder = [[]],
-        res = '',
-        y = 0;
+  function parseConsecutiveLists(list, listType, trimTrailing) {
+    // check if we caught 2 or more consecutive lists by mistake
+    // we use the counterRgx, meaning if listType is UL we look for UL and vice versa
+    var counterRxg = (listType === 'ul') ? /^ {0,2}\d+\.[ \t]/gm : /^ {0,2}[*+-][ \t]/gm,
+      subLists = [],
+      result = '';
 
-    // Initialize first sublist
-    holder[0].type = listType;
+    if (list.search(counterRxg) !== -1) {
+      (function parseCL(txt) {
+        var pos = txt.search(counterRxg);
+        if (pos !== -1) {
+          // slice
+          result += '\n\n<' + listType + '>' + processListItems(txt.slice(0, pos), !!trimTrailing) + '</' + listType + '>\n\n';
 
-    for (var i = 0; i < results.length; ++i) {
-      var txt = results[i].slice(2),
-          nListType = results[i].slice(0, 2);
+          // invert counterType and listType
+          listType = (listType === 'ul') ? 'ol' : 'ul';
+          counterRxg = (listType === 'ul') ? /^ {0,2}\d+\.[ \t]/gm : /^ {0,2}[*+-][ \t]/gm;
 
-      if (listType !== nListType) {
-        y++;
-        holder[y] = [];
-        holder[y].type = nListType;
-        listType = nListType;
-      }
-      holder[y].push(txt);
-    }
-    for (i = 0; i < holder.length; ++i) {
-      res += '<' + holder[i].type + '>\n';
-      for (var ii = 0; ii < holder[i].length; ++ii) {
-        if (holder[i].length > 1 && ii === holder[i].length - 1 && !cthulhu.test(holder[i][ii - 1])) {
-          //holder[i][ii] = holder[i][ii].replace(cthulhu, '');
+          //recurse
+          parseCL(txt.slice(pos));
+        } else {
+          result += '\n\n<' + listType + '>' + processListItems(txt, !!trimTrailing) + '</' + listType + '>\n\n';
         }
-        res += holder[i][ii];
+      })(list);
+      for (var i = 0; i < subLists.length; ++i) {
+
       }
-      res += '</' + holder[i].type + '>\n';
+    } else {
+      result = '\n\n<' + listType + '>' + processListItems(list, !!trimTrailing) + '</' + listType + '>\n\n';
     }
-    return res;
+
+    return result;
   }
 
   // attacklab: add sentinel to hack around khtml/safari bug:
@@ -139,41 +139,17 @@ showdown.subParser('lists', function (text, options, globals) {
   var wholeList = /^(([ ]{0,3}([*+-]|\d+[.])[ \t]+)[^\r]+?(~0|\n{2,}(?=\S)(?![ \t]*(?:[*+-]|\d+[.])[ \t]+)))/gm;
 
   if (globals.gListLevel) {
-    text = text.replace(wholeList, function (wholeMatch, m1, m2) {
-      var listType = (m2.search(/[*+-]/g) > -1) ? 'ul' : 'ol',
-          result = processListItems(m1);
-
-      // Turn double returns into triple returns, so that we can make a
-      // paragraph for the last item in a list, if necessary:
-      //list = list.replace(/\n{2,}/g, '\n\n\n');
-      //result = processListItems(list);
-
-      // Trim any trailing whitespace, to put the closing `</$list_type>`
-      // up on the preceding line, to get it past the current stupid
-      // HTML block parser. This is a hack to work around the terrible
-      // hack that is the HTML block parser.
-      result = result.replace(/\s+$/, '');
-      var splRes = result.split(spl);
-      splRes.shift();
-      result = splitConsecutiveLists(splRes, listType);
-      return result;
+    text = text.replace(wholeList, function (wholeMatch, list, m2) {
+      var listType = (m2.search(/[*+-]/g) > -1) ? 'ul' : 'ol';
+      return parseConsecutiveLists(list, listType, true);
     });
   } else {
-    wholeList = /(\n\n|^\n?)(([ ]{0,3}([*+-]|\d+[.])[ \t]+)[^\r]+?(~0|\n{2,}(?=\S)(?![ \t]*(?:[*+-]|\d+[.])[ \t]+)))/g;
+    wholeList = /(\n\n|^\n?)(([ ]{0,3}([*+-]|\d+[.])[ \t]+)[^\r]+?(~0|\n{2,}(?=\S)(?![ \t]*(?:[*+-]|\d+[.])[ \t]+)))/gm;
     //wholeList = /(\n\n|^\n?)( {0,3}([*+-]|\d+\.)[ \t]+[\s\S]+?)(?=(~0)|(\n\n(?!\t| {2,}| {0,3}([*+-]|\d+\.)[ \t])))/g;
+    text = text.replace(wholeList, function (wholeMatch, m1, list, m3) {
 
-    text = text.replace(wholeList, function (wholeMatch, m1, m2, m3) {
-
-      // Turn double returns into triple returns, so that we can make a
-      // paragraph for the last item in a list, if necessary:
-      var list = m2.replace(/\n{2,}/g, '\n\n\n'),
-      //var list = (m2.slice(-2) !== '~0') ? m2 + '\n' : m2, //add a newline after the list
-          listType = (m3.search(/[*+-]/g) > -1) ? 'ul' : 'ol',
-          result = processListItems(list),
-          splRes = result.split(spl);
-
-      splRes.shift();
-      return m1 + splitConsecutiveLists(splRes, listType) + '\n';
+      var listType = (m3.search(/[*+-]/g) > -1) ? 'ul' : 'ol';
+      return parseConsecutiveLists(list, listType);
     });
   }
 

test/cases/list-followed-by-blockquote.html

@@ -0,0 +1,15 @@
+<h1 id="sometitle">some title</h1>
+
+<ol>
+    <li>list item 1</li>
+    <li>list item 2</li>
+</ol>
+
+<blockquote>
+    <p>some text in a blockquote</p>
+</blockquote>
+
+<ul>
+    <li>another list item 1</li>
+    <li>another list item 2</li>
+</ul>

test/cases/list-followed-by-blockquote.md

@@ -0,0 +1,9 @@
+# some title
+
+1. list item 1
+2. list item 2
+
+> some text in a blockquote
+
+* another list item 1
+* another list item 2

test/cases/list-followed-by-ghcode.html

@@ -0,0 +1,16 @@
+<h1 id="sometitle">some title</h1>
+
+<ol>
+    <li>list item 1</li>
+    <li>list item 2</li>
+</ol>
+
+<pre><code>some code
+
+    and some other line of code
+</code></pre>
+
+<ul>
+    <li>another list item 1</li>
+    <li>another list item 2</li>
+</ul>

test/cases/list-followed-by-ghcode.md

@@ -0,0 +1,13 @@
+# some title
+
+1. list item 1
+2. list item 2
+
+```
+some code
+
+and some other line of code
+```
+
+* another list item 1
+* another list item 2

test/cases/paragraphed-list-with-sublists.html

@@ -0,0 +1,15 @@
+<ul>
+  <li><p>foo</p>
+    <ul>
+      <li><p>bazinga</p></li>
+      <li><p>yeah</p></li>
+    </ul>
+  </li>
+  <li><p>bar</p>
+    <ol>
+      <li><p>damn</p></li>
+      <li><p>so many paragraphs</p></li>
+    </ol>
+  </li>
+  <li><p>baz</p></li>
+</ul>

test/cases/paragraphed-list-with-sublists.md

@@ -0,0 +1,13 @@
+ - foo
+ 
+   - bazinga
+    
+   - yeah
+ 
+ - bar
+ 
+   1. damn
+    
+   2. so many paragraphs
+ 
+ - baz

test/ghost/underscore.html

@@ -45,7 +45,7 @@
 </ol>
 
 <blockquote>
-<p>foo_bar_baz foo_bar_baz_bar_foo <em>foo_bar baz_bar</em> baz_foo</p>
+<p>blockquote foo_bar_baz foo_bar_baz_bar_foo <em>foo_bar baz_bar</em> baz_foo</p>
 </blockquote>
 
 <ul>

test/ghost/underscore.md

@@ -45,7 +45,7 @@ foo_bar_baz foo_bar_baz_bar_foo _foo_bar baz_bar_ baz_foo
 1. foo_bar_baz foo_bar_baz_bar_foo _foo_bar baz_bar_ baz_foo
 2. foo_bar_baz foo_bar_baz_bar_foo _foo_bar baz_bar_ baz_foo
 
-> foo_bar_baz foo_bar_baz_bar_foo _foo_bar baz_bar_ baz_foo
+> blockquote foo_bar_baz foo_bar_baz_bar_foo _foo_bar baz_bar_ baz_foo
 
 * foo_bar_baz foo_bar_baz_bar_foo _foo_bar baz_bar_ baz_foo
 * foo_bar_baz foo_bar_baz_bar_foo _foo_bar baz_bar_ baz_foo

test/issues/#142.odd_behaviour_for_multiple_consecutive_lists.html

@@ -1,8 +1,12 @@
 <ul>
     <li>Item 1</li>
-    <li><p>Item 2</p></li>
+    <li>Item 2</li>
 </ul>
 <ol>
-    <li><p>Item 1</p></li>
+    <li>Item 1</li>
     <li>Item 2</li>
 </ol>
+<ul>
+    <li>Item 1</li>
+    <li>Item 2</li>
+</ul>

test/issues/#142.odd_behaviour_for_multiple_consecutive_lists.md

@@ -3,3 +3,6 @@
 
 1. Item 1
 2. Item 2
+
+- Item 1
+- Item 2

test/issues/#183.gh_code_blocks_within_lists_do_not_render_properly.html

@@ -0,0 +1,16 @@
+<ol>
+    <li>
+        <p>Hi, I am a thing</p>
+
+        <pre><code class="sh language-sh">$ git clone thing.git
+
+dfgdfg
+</code></pre></li>
+    <li>
+        <p>I am another thing!</p>
+
+        <pre><code class="sh language-sh">$ git clone other-thing.git
+
+foobar
+</code></pre></li>
+</ol>

test/issues/#183.gh_code_blocks_within_lists_do_not_render_properly.md

@@ -0,0 +1,17 @@
+1. Hi, I am a thing
+
+   ```sh
+    
+   $ git clone thing.git
+   
+   dfgdfg
+   ```
+
+1. I am another thing!
+
+   ```sh
+   
+   $ git clone other-thing.git
+
+   foobar
+   ```

test/karlcow/ordered-list-inner-par-list.html

@@ -5,5 +5,7 @@
       <li>inner par list</li>
     </ul>
   </li>
-  <li><p>2</p></li>
+  <li>
+    <p>2</p>
+  </li>
 </ol>