Clean up compile-markdown utility

Author: dfreeman

lib/utils/compile-markdown.js

@@ -3,18 +3,18 @@
 const marked = require('marked');
 const highlightjs = require('highlightjs');
 
-module.exports = function compileMarkdown(source, options) {
-  let tokens;
-  let config = { highlight };
+module.exports = function compileMarkdown(source, config) {
+  let tokens = marked.lexer(source);
+  let markedOptions = {
+    highlight,
+    renderer: new HBSRenderer(config)
+  };
 
-  if (options && options.targetHandlebars) {
-    config.renderer = new HBSRenderer();
-    tokens = compactParagraphs(source);
-  } else {
-    tokens = marked.lexer(source);
+  if (config && config.targetHandlebars) {
+    tokens = compactParagraphs(tokens);
   }
 
-  return `<div class="docs-md">${marked.parser(tokens, config).trim()}</div>`;
+  return `<div class="docs-md">${marked.parser(tokens, markedOptions).trim()}</div>`;
 };
 
 function highlight(code, lang) {
@@ -25,25 +25,29 @@ function highlight(code, lang) {
   }
 }
 
-function compactParagraphs(source) {
-  let tokens = marked.lexer(source);
+// Whitespace can imply paragraphs in Markdown, which can result
+// in interleaving between <p> tags and block component invocations,
+// so this scans the Marked tokens to turn things like this:
+//    <p>{{#my-component}}<p>
+//    <p>{{/my-component}}</p>
+// Into this:
+//    <p>{{#my-component}} {{/my-component}}</p>
+function compactParagraphs(tokens) {
   let compacted = [];
 
   compacted.links = tokens.links;
 
-  let diff = 0;
+  let balance = 0;
   for (let token of tokens) {
-    let wasBalanced = diff === 0;
-
-    diff += count(/\{\{#/g, token.text);
-    diff -= count(/\{\{\//g, token.text);
-
-    if (wasBalanced) {
+    if (balance === 0) {
       compacted.push(token);
     } else {
       let last = compacted[compacted.length - 1];
       last.text = `${last.text} ${token.text}`;
     }
+
+    balance += count(/\{\{#/g, token.text);
+    balance -= count(/\{\{\//g, token.text);
   }
 
   return compacted;
@@ -56,21 +60,38 @@ function count(regex, string) {
 }
 
 class HBSRenderer extends marked.Renderer {
-  // Escape curlies in code spans/blocks to avoid treating them as Handlebars
+  constructor(config) {
+    super();
+    this.config = config || {};
+  }
+
   codespan() {
-    return this._escapeCurlies(super.codespan.apply(this, arguments));
+    return this._processCode(super.codespan.apply(this, arguments));
   }
 
   code() {
-    let code = this._escapeCurlies(super.code.apply(this, arguments));
+    let code = this._processCode(super.code.apply(this, arguments));
     return code.replace(/^<pre>/, '<pre class="docs-md__code">');
   }
 
   // Unescape quotes in text, as they may be part of a Handlebars statement
   text() {
-    return super.text.apply(this, arguments)
-      .replace(/&quot;|&#34;/g, `"`)
-      .replace(/&apos;|&#39;/g, `'`);
+    let text = super.text.apply(this, arguments);
+    if (this.config.targetHandlebars) {
+      text = text
+        .replace(/&quot;|&#34;/g, `"`)
+        .replace(/&apos;|&#39;/g, `'`);
+    }
+    return text;
+  }
+
+  // Escape curlies in code spans/blocks to avoid treating them as Handlebars
+  _processCode(string) {
+    if (this.config.targetHandlebars) {
+      string = this._escapeCurlies(string);
+    }
+
+    return string;
   }
 
   _escapeCurlies(string) {