fix(tables): pipe char can now be escaped

Pipe character is now treated as a special markdown char, which makes it possible to escape it. Closes #345
showdownjs · Feb 21, 2017 · 1ebc195 · 1ebc195
1 parent 5d40c7a
commit 1ebc195
Show file tree

Hide file tree

Showing 11 changed files with 57 additions and 10 deletions.
diff --git a/dist/showdown.js b/dist/showdown.js
diff --git a/dist/showdown.js.map b/dist/showdown.js.map
diff --git a/dist/showdown.min.js b/dist/showdown.min.js
diff --git a/dist/showdown.min.js.map b/dist/showdown.min.js.map
diff --git a/src/subParsers/encodeBackslashEscapes.js b/src/subParsers/encodeBackslashEscapes.js
@@ -14,7 +14,7 @@ showdown.subParser('encodeBackslashEscapes', function (text, options, globals) {
   text = globals.converter._dispatch('encodeBackslashEscapes.before', text, options, globals);
 
   text = text.replace(/\\(\\)/g, showdown.helper.escapeCharactersCallback);
-  text = text.replace(/\\([`*_{}\[\]()>#+.!~=-])/g, showdown.helper.escapeCharactersCallback);
+  text = text.replace(/\\([`*_{}\[\]()>#+.!~=|-])/g, showdown.helper.escapeCharactersCallback);
 
   text = globals.converter._dispatch('encodeBackslashEscapes.after', text, options, globals);
   return text;

diff --git a/src/subParsers/escapeSpecialCharsWithinTagAttributes.js b/src/subParsers/escapeSpecialCharsWithinTagAttributes.js
@@ -13,7 +13,7 @@ showdown.subParser('escapeSpecialCharsWithinTagAttributes', function (text, opti
   text = text.replace(regex, function (wholeMatch) {
     return wholeMatch
       .replace(/(.)<\/?code>(?=.)/g, '$1`')
-      .replace(/([\\`*_~=])/g, showdown.helper.escapeCharactersCallback);
+      .replace(/([\\`*_~=|])/g, showdown.helper.escapeCharactersCallback);
   });
 
   text = globals.converter._dispatch('escapeSpecialCharsWithinTagAttributes.after', text, options, globals);

diff --git a/src/subParsers/tables.js b/src/subParsers/tables.js
@@ -57,6 +57,10 @@ showdown.subParser('tables', function (text, options, globals) {
 
   text = globals.converter._dispatch('tables.before', text, options, globals);
 
+  // find escaped pipe characters
+  text = text.replace(/\\(\|)/g, showdown.helper.escapeCharactersCallback);
+
+  // parse tables
   text = text.replace(tableRgx, function (rawTable) {
 
     var i, tableLines = rawTable.split('\n');

diff --git a/test/features/tables/#345.escape-pipe-character.html b/test/features/tables/#345.escape-pipe-character.html
@@ -0,0 +1,30 @@
+<table>
+    <thead>
+    <tr>
+        <th>Operator</th>
+        <th>Description</th>
+    </tr>
+    </thead>
+    <tbody>
+    <tr>
+        <td>&amp;</td>
+        <td>Logical AND</td>
+    </tr>
+    <tr>
+        <td>&amp;&amp;</td>
+        <td>Shortcut AND</td>
+    </tr>
+    <tr>
+        <td>|</td>
+        <td>Logical OR</td>
+    </tr>
+    <tr>
+        <td>||</td>
+        <td>Shortcut OR</td>
+    </tr>
+    <tr>
+        <td>^</td>
+        <td>Logical XOR</td>
+    </tr>
+  </tbody>
+</table>
diff --git a/test/features/tables/#345.escape-pipe-character.md b/test/features/tables/#345.escape-pipe-character.md
@@ -0,0 +1,7 @@
+| Operator | Description |
+|----------|-------------|
+| & | Logical AND |
+| && | Shortcut AND |
+| \| | Logical OR |
+| \|\| | Shortcut OR |
+| ^ | Logical XOR |
diff --git a/test/issues/#345.no-escape-for-the-pipe-character.html b/test/issues/#345.no-escape-for-the-pipe-character.html
@@ -0,0 +1 @@
+<p>this |</p>
diff --git a/test/issues/#345.no-escape-for-the-pipe-character.md b/test/issues/#345.no-escape-for-the-pipe-character.md
@@ -0,0 +1 @@
+this \|