Merge pull request commonmark#114 from tmpfs/renderer-tidy

Renderer tidy

Author: jgm

lib/render/html.js

@@ -2,38 +2,35 @@
 
 var Renderer = require('./renderer');
 
-var esc = require('../common').escapeXml;
-
 var reUnsafeProtocol = /^javascript:|vbscript:|file:|data:/i;
 var reSafeDataProtocol = /^data:image\/(?:png|gif|jpeg|webp)/i;
 
 var potentiallyUnsafe = function(url) {
-    return reUnsafeProtocol.test(url) &&
-        !reSafeDataProtocol.test(url);
+  return reUnsafeProtocol.test(url) &&
+      !reSafeDataProtocol.test(url);
 };
 
 // Helper function to produce an HTML tag.
 function tag(name, attrs, selfclosing) {
-    if (this.disableTags > 0) {
-        return;
-    }
-    this.buffer += ('<' + name);
-    if (attrs && attrs.length > 0) {
-        var i = 0;
-        var attrib;
-        while ((attrib = attrs[i]) !== undefined) {
-            this.buffer += (' ' + attrib[0] + '="' + attrib[1] + '"');
-            i++;
-        }
-    }
-    if (selfclosing) {
-        this.buffer += ' /';
+  if (this.disableTags > 0) {
+    return;
+  }
+  this.buffer += ('<' + name);
+  if (attrs && attrs.length > 0) {
+    var i = 0;
+    var attrib;
+    while ((attrib = attrs[i]) !== undefined) {
+      this.buffer += (' ' + attrib[0] + '="' + attrib[1] + '"');
+      i++;
     }
-    this.buffer += '>';
-    this.lastOut = '>';
+  }
+  if (selfclosing) {
+    this.buffer += ' /';
+  }
+  this.buffer += '>';
+  this.lastOut = '>';
 }
 
-
 function HtmlRenderer(options) {
   options = options || {};
   // by default, soft breaks are rendered as newlines in HTML
@@ -64,38 +61,37 @@ function linebreak() {
 function link(node, entering) {
   var attrs = this.attrs(node);
   if (entering) {
-      if (!(this.options.safe && potentiallyUnsafe(node.destination))) {
-          attrs.push(['href', esc(node.destination, true)]);
-      }
-      if (node.title) {
-          attrs.push(['title', esc(node.title, true)]);
-      }
-      this.tag('a', attrs);
+    if (!(this.options.safe && potentiallyUnsafe(node.destination))) {
+      attrs.push(['href', this.esc(node.destination, true)]);
+    }
+    if (node.title) {
+      attrs.push(['title', this.esc(node.title, true)]);
+    }
+    this.tag('a', attrs);
   } else {
-      this.tag('/a');
+    this.tag('/a');
   }
 }
 
 function image(node, entering) {
   if (entering) {
-      if (this.disableTags === 0) {
-          if (this.options.safe &&
-               potentiallyUnsafe(node.destination)) {
-              this.lit('<img src="" alt="');
-          } else {
-              this.lit('<img src="' + esc(node.destination, true) +
-                  '" alt="');
-          }
+    if (this.disableTags === 0) {
+      if (this.options.safe && potentiallyUnsafe(node.destination)) {
+        this.lit('<img src="" alt="');
+      } else {
+        this.lit('<img src="' + this.esc(node.destination, true) +
+            '" alt="');
       }
-      this.disableTags += 1;
+    }
+    this.disableTags += 1;
   } else {
-      this.disableTags -= 1;
-      if (this.disableTags === 0) {
-          if (node.title) {
-              this.lit('" title="' + esc(node.title, true));
-          }
-          this.lit('" />');
+    this.disableTags -= 1;
+    if (this.disableTags === 0) {
+      if (node.title) {
+        this.lit('" title="' + this.esc(node.title, true));
       }
+      this.lit('" />');
+    }
   }
 }
 
@@ -111,29 +107,29 @@ function paragraph(node, entering) {
   var grandparent = node.parent.parent
     , attrs = this.attrs(node);
   if (grandparent !== null &&
-      grandparent.type === 'list') {
-      if (grandparent.listTight) {
-          return;
-      }
+    grandparent.type === 'list') {
+    if (grandparent.listTight) {
+      return;
+    }
   }
   if (entering) {
-      this.cr();
-      this.tag('p', attrs);
+    this.cr();
+    this.tag('p', attrs);
   } else {
-      this.tag('/p');
-      this.cr();
+    this.tag('/p');
+    this.cr();
   }
 }
 
 function heading(node, entering) {
   var tagname = 'h' + node.level
     , attrs = this.attrs(node);
   if (entering) {
-      this.cr();
-      this.tag(tagname, attrs);
+    this.cr();
+    this.tag(tagname, attrs);
   } else {
-      this.tag('/' + tagname);
-      this.cr();
+    this.tag('/' + tagname);
+    this.cr();
   }
 }
 
@@ -147,7 +143,7 @@ function code_block(node) {
   var info_words = node.info ? node.info.split(/\s+/) : []
     , attrs = this.attrs(node);
   if (info_words.length > 0 && info_words[0].length > 0) {
-      attrs.push(['class', 'language-' + esc(info_words[0], true)]);
+    attrs.push(['class', 'language-' + this.esc(info_words[0], true)]);
   }
   this.cr();
   this.tag('pre');
@@ -168,13 +164,13 @@ function thematic_break(node) {
 function block_quote(node, entering) {
   var attrs = this.attrs(node);
   if (entering) {
-      this.cr();
-      this.tag('blockquote', attrs);
-      this.cr();
+    this.cr();
+    this.tag('blockquote', attrs);
+    this.cr();
   } else {
-      this.cr();
-      this.tag('/blockquote');
-      this.cr();
+    this.cr();
+    this.tag('/blockquote');
+    this.cr();
   }
 }
 
@@ -183,81 +179,81 @@ function list(node, entering) {
     , attrs = this.attrs(node);
 
   if (entering) {
-      var start = node.listStart;
-      if (start !== null && start !== 1) {
-          attrs.push(['start', start.toString()]);
-      }
-      this.cr();
-      this.tag(tagname, attrs);
-      this.cr();
+    var start = node.listStart;
+    if (start !== null && start !== 1) {
+      attrs.push(['start', start.toString()]);
+    }
+    this.cr();
+    this.tag(tagname, attrs);
+    this.cr();
   } else {
-      this.cr();
-      this.tag('/' + tagname);
-      this.cr();
+    this.cr();
+    this.tag('/' + tagname);
+    this.cr();
   }
 }
 
 function item(node, entering) {
   var attrs = this.attrs(node);
   if (entering) {
-      this.tag('li', attrs);
+    this.tag('li', attrs);
   } else {
-      this.tag('/li');
-      this.cr();
+    this.tag('/li');
+    this.cr();
   }
 }
 
 function html_inline(node) {
   if (this.options.safe) {
-      this.lit('<!-- raw HTML omitted -->');
+    this.lit('<!-- raw HTML omitted -->');
   } else {
-      this.lit(node.literal);
+    this.lit(node.literal);
   }
 }
 
 function html_block(node) {
   this.cr();
   if (this.options.safe) {
-      this.lit('<!-- raw HTML omitted -->');
+    this.lit('<!-- raw HTML omitted -->');
   } else {
-      this.lit(node.literal);
+    this.lit(node.literal);
   }
   this.cr();
 }
 
 function custom_inline(node, entering) {
   if (entering && node.onEnter) {
-      this.lit(node.onEnter);
+    this.lit(node.onEnter);
   } else if (!entering && node.onExit) {
-      this.lit(node.onExit);
+    this.lit(node.onExit);
   }
 }
 
 function custom_block(node, entering) {
   this.cr();
   if (entering && node.onEnter) {
-      this.lit(node.onEnter);
+    this.lit(node.onEnter);
   } else if (!entering && node.onExit) {
-      this.lit(node.onExit);
+    this.lit(node.onExit);
   }
   this.cr();
 }
 
 /* Helper methods */
 
 function out(s) {
-  this.lit(esc(s, false));
+  this.lit(this.esc(s, false));
 }
 
 function attrs (node) {
   var att = [];
   if (this.options.sourcepos) {
-      var pos = node.sourcepos;
-      if (pos) {
-          att.push(['data-sourcepos', String(pos[0][0]) + ':' +
-                      String(pos[0][1]) + '-' + String(pos[1][0]) + ':' +
-                      String(pos[1][1])]);
-      }
+    var pos = node.sourcepos;
+    if (pos) {
+      att.push(['data-sourcepos', String(pos[0][0]) + ':' +
+        String(pos[0][1]) + '-' + String(pos[1][0]) + ':' +
+        String(pos[1][1])]);
+    }
   }
   return att;
 }
@@ -285,6 +281,8 @@ HtmlRenderer.prototype.item = item;
 HtmlRenderer.prototype.custom_inline = custom_inline;
 HtmlRenderer.prototype.custom_block = custom_block;
 
+HtmlRenderer.prototype.esc = require('../common').escapeXml;
+
 HtmlRenderer.prototype.out = out;
 HtmlRenderer.prototype.tag = tag;
 HtmlRenderer.prototype.attrs = attrs;

lib/render/renderer.js

@@ -34,10 +34,13 @@ function lit(str) {
   this.lastOut = str;
 }
 
+/**
+ *  Output a newline to the buffer.
+ */
 function cr() {
-    if (this.lastOut !== '\n') {
-        this.lit('\n');
-    }
+  if (this.lastOut !== '\n') {
+    this.lit('\n');
+  }
 }
 
 /**
@@ -51,9 +54,22 @@ function out(str) {
   this.lit(str);
 }
 
+/**
+ *  Escape a string for the target renderer.
+ *
+ *  Abstract function that should be implemented by concrete 
+ *  renderer implementations.
+ *
+ *  @param str {String} The string to escape.
+ */
+function esc(str) {
+  return str;
+}
+
 Renderer.prototype.render = render;
 Renderer.prototype.out = out;
 Renderer.prototype.lit = lit;
 Renderer.prototype.cr  = cr;
+Renderer.prototype.esc  = esc;
 
 module.exports = Renderer;