Refactor code-style

Author: wooorm

lib/all.js

@@ -4,7 +4,7 @@ var one = require('./one')
 
 module.exports = all
 
-/* Stringify all children of `parent`. */
+// Stringify all children of `parent`.
 function all(ctx, parent) {
   var children = parent && parent.children
   var length = children && children.length

lib/comment.js

@@ -2,7 +2,7 @@
 
 module.exports = comment
 
-/* Stringify a comment `node`. */
+// Stringify a comment `node`.
 function comment(ctx, node) {
   return '<!--' + node.value + '-->'
 }

lib/constants.js

@@ -1,47 +1,67 @@
 'use strict'
 
 // Characters.
-var NULL = '\0'
-var AMP = '&'
-var SP = ' '
-var TB = '\t'
-var GR = '`'
-var DQ = '"'
-var SQ = "'"
-var EQ = '='
-var LT = '<'
-var GT = '>'
-var SO = '/'
-var LF = '\n'
-var CR = '\r'
-var FF = '\f'
+var nil = '\0'
+var ampersand = '&'
+var space = ' '
+var tab = '\t'
+var graveAccent = '`'
+var quotationMark = '"'
+var apostrophe = "'"
+var equalsTo = '='
+var lessThan = '<'
+var greaterThan = '>'
+var slash = '/'
+var lineFeed = '\n'
+var carriageReturn = '\r'
+var formFeed = '\f'
+
+var whitespace = [space, tab, lineFeed, carriageReturn, formFeed]
 
-var whitespace = [SP, TB, LF, CR, FF]
 // https://html.spec.whatwg.org/#attribute-name-state
-var name = whitespace.concat(AMP, SO, GT, EQ)
+var name = whitespace.concat(ampersand, slash, greaterThan, equalsTo)
+
 // https://html.spec.whatwg.org/#attribute-value-(unquoted)-state
-var unquoted = whitespace.concat(AMP, GT)
-var unquotedSafe = unquoted.concat(NULL, DQ, SQ, LT, EQ, GR)
+var unquoted = whitespace.concat(ampersand, greaterThan)
+var unquotedSafe = unquoted.concat(
+  nil,
+  quotationMark,
+  apostrophe,
+  lessThan,
+  equalsTo,
+  graveAccent
+)
+
 // https://html.spec.whatwg.org/#attribute-value-(single-quoted)-state
-var singleQuoted = [AMP, SQ]
+var singleQuoted = [ampersand, apostrophe]
+
 // https://html.spec.whatwg.org/#attribute-value-(double-quoted)-state
-var doubleQuoted = [AMP, DQ]
+var doubleQuoted = [ampersand, quotationMark]
 
 // Maps of subsets. Each value is a matrix of tuples.
 // The first value causes parse errors, the second is valid.
 // Of both values, the first value is unsafe, and the second is safe.
 module.exports = {
   name: [
-    [name, name.concat(DQ, SQ, GR)],
-    [name.concat(NULL, DQ, SQ, LT), name.concat(NULL, DQ, SQ, LT, GR)]
+    [name, name.concat(quotationMark, apostrophe, graveAccent)],
+    [
+      name.concat(nil, quotationMark, apostrophe, lessThan),
+      name.concat(nil, quotationMark, apostrophe, lessThan, graveAccent)
+    ]
   ],
   unquoted: [[unquoted, unquotedSafe], [unquotedSafe, unquotedSafe]],
   single: [
-    [singleQuoted, singleQuoted.concat(DQ, GR)],
-    [singleQuoted.concat(NULL), singleQuoted.concat(NULL, DQ, GR)]
+    [singleQuoted, singleQuoted.concat(quotationMark, graveAccent)],
+    [
+      singleQuoted.concat(nil),
+      singleQuoted.concat(nil, quotationMark, graveAccent)
+    ]
   ],
   double: [
-    [doubleQuoted, doubleQuoted.concat(SQ, GR)],
-    [doubleQuoted.concat(NULL), doubleQuoted.concat(NULL, SQ, GR)]
+    [doubleQuoted, doubleQuoted.concat(apostrophe, graveAccent)],
+    [
+      doubleQuoted.concat(nil),
+      doubleQuoted.concat(nil, apostrophe, graveAccent)
+    ]
   ]
 }

lib/doctype.js

@@ -2,7 +2,7 @@
 
 module.exports = doctype
 
-/* Stringify a doctype `node`. */
+// Stringify a doctype `node`.
 function doctype(ctx, node) {
   var sep = ctx.tightDoctype ? '' : ' '
   var name = node.name

lib/element.js

@@ -12,19 +12,15 @@ var constants = require('./constants')
 
 module.exports = element
 
-/* Constants. */
-var EMPTY = ''
-
-/* Characters. */
-var SPACE = ' '
-var DQ = '"'
-var SQ = "'"
-var EQ = '='
-var LT = '<'
-var GT = '>'
-var SO = '/'
-
-/* Stringify an element `node`. */
+var space = ' '
+var quotationMark = '"'
+var apostrophe = "'"
+var equalsTo = '='
+var lessThan = '<'
+var greaterThan = '>'
+var slash = '/'
+
+// Stringify an element `node`.
 function element(ctx, node, index, parent) {
   var parentSchema = ctx.schema
   var name = node.tagName
@@ -58,39 +54,37 @@ function element(ctx, node, index, parent) {
 
   content = all(ctx, root)
 
-  /* If the node is categorised as void, but it has
-   * children, remove the categorisation.  This
-   * enables for example `menuitem`s, which are
-   * void in W3C HTML but not void in WHATWG HTML, to
-   * be stringified properly. */
+  // If the node is categorised as void, but it has children, remove the
+  // categorisation.  This enables for example `menuitem`s, which are void in
+  // W3C HTML but not void in WHATWG HTML, to be stringified properly.
   selfClosing = content ? false : selfClosing
 
   if (attrs || !omit || !omit.opening(node, index, parent)) {
-    value = LT + name + (attrs ? SPACE + attrs : EMPTY)
+    value = lessThan + name + (attrs ? space + attrs : '')
 
     if (selfClosing && close) {
-      if (!ctx.tightClose || attrs.charAt(attrs.length - 1) === SO) {
-        value += SPACE
+      if (!ctx.tightClose || attrs.charAt(attrs.length - 1) === slash) {
+        value += space
       }
 
-      value += SO
+      value += slash
     }
 
-    value += GT
+    value += greaterThan
   }
 
   value += content
 
   if (!selfClosing && (!omit || !omit.closing(node, index, parent))) {
-    value += LT + SO + name + GT
+    value += lessThan + slash + name + greaterThan
   }
 
   ctx.schema = parentSchema
 
   return value
 }
 
-/* Stringify all attributes. */
+// Stringify all attributes.
 function attributes(ctx, props) {
   var values = []
   var key
@@ -125,16 +119,16 @@ function attributes(ctx, props) {
       last = result.charAt(result.length - 1)
     }
 
-    /* In tight mode, don’t add a space after quoted attributes. */
-    if (index !== length - 1 && last !== DQ && last !== SQ) {
-      values[index] = result + SPACE
+    // In tight mode, don’t add a space after quoted attributes.
+    if (index !== length - 1 && last !== quotationMark && last !== apostrophe) {
+      values[index] = result + space
     }
   }
 
-  return values.join(EMPTY)
+  return values.join('')
 }
 
-/* Stringify one attribute. */
+// Stringify one attribute.
 function attribute(ctx, key, value) {
   var schema = ctx.schema
   var space = schema.space
@@ -155,7 +149,7 @@ function attribute(ctx, key, value) {
     value === false ||
     (typeof value === 'number' && isNaN(value))
   ) {
-    return EMPTY
+    return ''
   }
 
   name = attributeName(ctx, name)
@@ -171,7 +165,7 @@ function attribute(ctx, key, value) {
   return name + attributeValue(ctx, key, value, info)
 }
 
-/* Stringify the attribute name. */
+// Stringify the attribute name.
 function attributeName(ctx, name) {
   // Always encode without parse errors in non-HTML.
   var valid = ctx.schema.space === 'html' ? ctx.valid : 1
@@ -180,7 +174,7 @@ function attributeName(ctx, name) {
   return entities(name, xtend(ctx.entities, {subset: subset}))
 }
 
-/* Stringify the attribute value. */
+// Stringify the attribute value.
 function attributeValue(ctx, key, value, info) {
   var options = ctx.entities
   var quote = ctx.quote
@@ -190,8 +184,8 @@ function attributeValue(ctx, key, value, info) {
   var subset
 
   if (typeof value === 'object' && 'length' in value) {
-    /* `spaces` doesn’t accept a second argument, but it’s
-     * given here just to keep the code cleaner. */
+    // `spaces` doesn’t accept a second argument, but it’s given here just to
+    // keep the code cleaner.
     value = (info.commaSeparated ? commas : spaces)(value, {
       padLeft: !ctx.tightLists
     })
@@ -202,7 +196,7 @@ function attributeValue(ctx, key, value, info) {
   if (space !== 'html' || value || !ctx.collapseEmpty) {
     unquoted = value
 
-    /* Check unquoted value. */
+    // Check unquoted value.
     if (space === 'html' && ctx.unquoted) {
       subset = constants.unquoted[ctx.valid][ctx.safe]
       unquoted = entities(
@@ -211,14 +205,14 @@ function attributeValue(ctx, key, value, info) {
       )
     }
 
-    /* If `value` contains entities when unquoted... */
+    // If `value` contains entities when unquoted…
     if (space !== 'html' || !ctx.unquoted || unquoted !== value) {
-      /* If the alternative is less common than `quote`, switch. */
+      // If the alternative is less common than `quote`, switch.
       if (alternative && ccount(value, quote) > ccount(value, alternative)) {
         quote = alternative
       }
 
-      subset = quote === SQ ? constants.single : constants.double
+      subset = quote === apostrophe ? constants.single : constants.double
       // Always encode without parse errors in non-HTML.
       subset = subset[space === 'html' ? ctx.valid : 1][ctx.safe]
 
@@ -227,8 +221,8 @@ function attributeValue(ctx, key, value, info) {
       value = quote + value + quote
     }
 
-    /* Don’t add a `=` for unquoted empties. */
-    value = value ? EQ + value : value
+    // Don’t add a `=` for unquoted empties.
+    value = value ? equalsTo + value : value
   }
 
   return value

lib/index.js

@@ -8,20 +8,25 @@ var one = require('./one')
 
 module.exports = toHTML
 
-/* Characters. */
-var DQ = '"'
-var SQ = "'"
+var quotationMark = '"'
+var apostrophe = "'"
 
-/* Stringify the given HAST node. */
+// Stringify the given HAST node.
 function toHTML(node, options) {
   var settings = options || {}
-  var quote = settings.quote || DQ
-  var alternative = quote === DQ ? SQ : DQ
+  var quote = settings.quote || quotationMark
+  var alternative = quote === quotationMark ? apostrophe : quotationMark
   var smart = settings.quoteSmart
 
-  if (quote !== DQ && quote !== SQ) {
+  if (quote !== quotationMark && quote !== apostrophe) {
     throw new Error(
-      'Invalid quote `' + quote + '`, expected `' + SQ + '` or `' + DQ + '`'
+      'Invalid quote `' +
+        quote +
+        '`, expected `' +
+        apostrophe +
+        '` or `' +
+        quotationMark +
+        '`'
     )
   }