don't pretty-print code blocks that begin with "```plain" (jsdoc#1361)

Yaaqoub · Jul 23, 2017 · a63337b · a63337b
1 parent f27bf19
commit a63337b
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 5 deletions.
diff --git a/lib/jsdoc/util/markdown.js b/lib/jsdoc/util/markdown.js
@@ -107,10 +107,21 @@ function escapeCode(source) {
  * @return {string} The wrapped code snippet.
  */
 function highlight(code, language) {
-    var langClass = language ? ' lang-' + language : '';
+    var classString;
+    var langClass = '';
 
-    return util.format('<pre class="prettyprint source%s"><code>%s</code></pre>', langClass,
-        escapeCode(code));
+    if (language && (language !== 'plain')) {
+        langClass = ' lang-' + language;
+    }
+
+    if (language !== 'plain') {
+        classString = util.format(' class="prettyprint source%s"', langClass);
+    }
+    else {
+        classString = ' class="source"';
+    }
+
+    return util.format('<pre%s><code>%s</code></pre>', classString, escapeCode(code));
 }
 
 /**

diff --git a/templates/default/static/styles/jsdoc-default.css b/templates/default/static/styles/jsdoc-default.css
@@ -273,7 +273,7 @@ tr > th:last-child { border-right: 1px solid #ddd; }
     margin: 0;
 }
 
-.prettyprint
+.source
 {
     border: 1px solid #ddd;
     width: 80%;
@@ -284,7 +284,7 @@ tr > th:last-child { border-right: 1px solid #ddd; }
     width: inherit;
 }
 
-.prettyprint code
+.source code
 {
     font-size: 100%;
     line-height: 18px;

diff --git a/test/specs/jsdoc/util/markdown.js b/test/specs/jsdoc/util/markdown.js
@@ -122,5 +122,14 @@ describe('jsdoc/util/markdown', function() {
 
             expect(parser('# Hello')).toBe('<h1 id="hello">Hello</h1>');
         });
+
+        it('should not pretty-print code blocks that start with "```plain"', function() {
+            var parser = markdown.getParser();
+            var markdownText = '```plain\nconsole.log("foo");\n```';
+            var convertedText = '<pre class="source"><code>console.log(&quot;foo&quot;);\n' +
+                '</code></pre>';
+
+            expect(parser(markdownText)).toBe(convertedText);
+        });
     });
 });