Refactor to improve bundle size

Author: wooorm

Diff for: index.js

@@ -1,21 +1,23 @@
 'use strict'
 
-var vfileLocation = require('vfile-location')
-var toString = require('nlcst-to-string')
-var position = require('unist-util-position')
-var phrasing = require('hast-util-phrasing')
 var embedded = require('hast-util-embedded')
-var whitespace = require('hast-util-whitespace')
+var convert = require('hast-util-is-element/convert')
+var phrasing = require('hast-util-phrasing')
 var textContent = require('hast-util-to-string')
-var is = require('hast-util-is-element')
+var whitespace = require('hast-util-whitespace')
+var toString = require('nlcst-to-string')
+var position = require('unist-util-position')
+var vfileLocation = require('vfile-location')
 
 module.exports = toNlcst
 
-var source = ['code']
-var ignore = ['script', 'style', 'svg', 'math', 'del']
-var explicit = ['p', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6']
+var push = [].push
 
-var flowAccepting = [
+var source = convert(['code', dataNlcstSourced])
+var ignore = convert(['script', 'style', 'svg', 'math', 'del', dataNlcstIgnore])
+var explicit = convert(['p', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6'])
+
+var flowAccepting = convert([
   'body',
   'article',
   'section',
@@ -39,7 +41,10 @@ var flowAccepting = [
   'fieldset',
   'details',
   'dialog'
-]
+])
+
+// See: <https://html.spec.whatwg.org/multipage/dom.html#paragraphs>
+var unravelInParagraph = convert(['a', 'ins', 'del', 'map'])
 
 // Transform `tree` to nlcst.
 function toNlcst(tree, file, Parser) {
@@ -66,8 +71,8 @@ function toNlcst(tree, file, Parser) {
     throw new Error('hast-util-to-nlcst expected position on nodes')
   }
 
-  location = vfileLocation(file)
   doc = String(file)
+  location = vfileLocation(doc)
   parser = 'parse' in Parser ? Parser : new Parser()
 
   // Transform hast to nlcst, and pass these into `parser.parse` to insert
@@ -79,55 +84,44 @@ function toNlcst(tree, file, Parser) {
   return {
     type: 'RootNode',
     children: results,
-    position: {
-      start: location.toPosition(0),
-      end: location.toPosition(doc.length)
-    }
+    position: {start: location.toPoint(0), end: location.toPoint(doc.length)}
   }
 
   function find(node) {
-    var children = node.children
-
     if (node.type === 'root') {
-      findAll(children)
-    } else if (is(node) && !ignored(node)) {
-      if (is(node, explicit)) {
+      findAll(node.children)
+    } else if (node.type === 'element' && !ignore(node)) {
+      if (explicit(node)) {
         // Explicit paragraph.
         add(node)
-      } else if (is(node, flowAccepting)) {
+      } else if (flowAccepting(node)) {
         // Slightly simplified version of: <https://html.spec.whatwg.org/#paragraphs>.
-        implicit(flattenAll(children))
+        implicit(flattenAll(node.children))
       } else {
         // Dig deeper.
-        findAll(children)
+        findAll(node.children)
       }
     }
   }
 
   function findAll(children) {
-    var length = children.length
     var index = -1
 
-    while (++index < length) {
+    while (++index < children.length) {
       find(children[index])
     }
   }
 
-  function flatten(node) {
-    if (is(node, ['a', 'ins', 'del', 'map'])) {
-      return flattenAll(node.children)
-    }
-
-    return node
-  }
-
   function flattenAll(children) {
     var results = []
-    var length = children.length
     var index = -1
 
-    while (++index < length) {
-      results = results.concat(flatten(children[index]))
+    while (++index < children.length) {
+      if (unravelInParagraph(children[index])) {
+        push.apply(results, flattenAll(children[index].children))
+      } else {
+        results.push(children[index])
+      }
     }
 
     return results
@@ -136,25 +130,22 @@ function toNlcst(tree, file, Parser) {
   function add(node) {
     var result = ('length' in node ? all : one)(node)
 
-    if (result.length > 0) {
+    if (result.length) {
       results.push(parser.tokenizeParagraph(result))
     }
   }
 
   function implicit(children) {
-    var length = children.length + 1
     var index = -1
-    var viable = false
     var start = -1
+    var viable
     var child
 
-    while (++index < length) {
+    while (++index <= children.length) {
       child = children[index]
 
       if (child && phrasing(child)) {
-        if (start === -1) {
-          start = index
-        }
+        if (start === -1) start = index
 
         if (!viable && !embedded(child) && !whitespace(child)) {
           viable = true
@@ -169,60 +160,50 @@ function toNlcst(tree, file, Parser) {
           find(child)
         }
 
-        viable = false
+        viable = null
         start = -1
       }
     }
   }
 
   // Convert `node` (hast) to nlcst.
   function one(node) {
-    var type = node.type
-    var tagName = type === 'element' ? node.tagName : null
-    var change
     var replacement
+    var change
 
-    if (type === 'text') {
-      change = true
+    if (node.type === 'text') {
       replacement = parser.tokenize(node.value)
-    } else if (tagName === 'wbr') {
       change = true
-      replacement = [parser.tokenizeWhiteSpace(' ')]
-    } else if (tagName === 'br') {
-      change = true
-      replacement = [parser.tokenizeWhiteSpace('\n')]
-    } else if (sourced(node)) {
-      change = true
-      replacement = [parser.tokenizeSource(textContent(node))]
-    } else if (type === 'root' || !ignored(node)) {
-      replacement = all(node.children)
-    } else {
-      return
-    }
-
-    if (!change) {
-      return replacement
+    } else if (node.type === 'element' && !ignore(node)) {
+      if (node.tagName === 'wbr') {
+        replacement = [parser.tokenizeWhiteSpace(' ')]
+        change = true
+      } else if (node.tagName === 'br') {
+        replacement = [parser.tokenizeWhiteSpace('\n')]
+        change = true
+      } else if (source(node)) {
+        replacement = [parser.tokenizeSource(textContent(node))]
+        change = true
+      } else {
+        replacement = all(node.children)
+      }
     }
 
-    return patch(replacement, location, location.toOffset(position.start(node)))
+    return change
+      ? patch(replacement, location, location.toOffset(position.start(node)))
+      : replacement
   }
 
   // Convert all `children` (hast) to nlcst.
   function all(children) {
-    var length = children && children.length
+    var results = []
     var index = -1
-    var result = []
-    var child
-
-    while (++index < length) {
-      child = one(children[index])
 
-      if (child) {
-        result = result.concat(child)
-      }
+    while (++index < children.length) {
+      push.apply(results, one(children[index]) || [])
     }
 
-    return result
+    return results
   }
 
   // Patch a position on each node in `nodes`.
@@ -231,26 +212,23 @@ function toNlcst(tree, file, Parser) {
   // Note that nlcst nodes are concrete, meaning that their starting and ending
   // positions can be inferred from their content.
   function patch(nodes, location, offset) {
-    var length = nodes.length
     var index = -1
     var start = offset
-    var children
-    var node
     var end
+    var node
 
-    while (++index < length) {
+    while (++index < nodes.length) {
       node = nodes[index]
-      children = node.children
 
-      if (children) {
-        patch(children, location, start)
+      if (node.children) {
+        patch(node.children, location, start)
       }
 
       end = start + toString(node).length
 
       node.position = {
-        start: location.toPosition(start),
-        end: location.toPosition(end)
+        start: location.toPoint(start),
+        end: location.toPoint(end)
       }
 
       start = end
@@ -260,12 +238,10 @@ function toNlcst(tree, file, Parser) {
   }
 }
 
-function sourced(node) {
-  var props = node.properties
-  return is(node) && (is(node, source) || props.dataNlcst === 'source')
+function dataNlcstSourced(node) {
+  return node.properties.dataNlcst === 'source'
 }
 
-function ignored(node) {
-  var props = node.properties
-  return is(node) && (is(node, ignore) || props.dataNlcst === 'ignore')
+function dataNlcstIgnore(node) {
+  return node.properties.dataNlcst === 'ignore'
 }

Diff for: package.json

@@ -37,7 +37,7 @@
     "hast-util-whitespace": "^1.0.0",
     "nlcst-to-string": "^2.0.0",
     "unist-util-position": "^3.0.0",
-    "vfile-location": "^3.0.0"
+    "vfile-location": "^3.1.0"
   },
   "devDependencies": {
     "browserify": "^17.0.0",
@@ -83,6 +83,7 @@
     "prettier": true,
     "esnext": false,
     "rules": {
+      "unicorn/explicit-length-check": "off",
       "unicorn/no-fn-reference-in-iterator": "off",
       "unicorn/prefer-optional-catch-binding": "off"
     },

Diff for: test/index.js

@@ -135,6 +135,33 @@ test('hast-util-to-nlcst', function (t) {
     st.end()
   })
 
+  t.test('should accept comments', function (st) {
+    var node = toNlcst(
+      {
+        type: 'comment',
+        value: 'a',
+        position: {start: {line: 1, column: 1}, end: {line: 1, column: 9}}
+      },
+      vfile('<!--a-->'),
+      Latin
+    )
+
+    st.deepEqual(
+      node,
+      {
+        type: 'RootNode',
+        children: [],
+        position: {
+          start: {line: 1, column: 1, offset: 0},
+          end: {line: 1, column: 9, offset: 8}
+        }
+      },
+      'should support comments'
+    )
+
+    st.end()
+  })
+
   t.end()
 })