Refactor code-style

Author: wooorm

lib/index.js

@@ -2,10 +2,7 @@
  * @typedef {import('unist').Node} UnistNode
  * @typedef {import('hast').Parent} Parent
  * @typedef {import('hast').Root} Root
- * @typedef {import('hast').DocType} Doctype
  * @typedef {import('hast').Element} Element
- * @typedef {import('hast').Text} Text
- * @typedef {import('hast').Comment} Comment
  * @typedef {Parent['children'][number]} Child
  * @typedef {Element['children'][number]} ElementChild
  * @typedef {Child|Root} Node
@@ -31,20 +28,20 @@ import {toString as nlcstToString} from 'nlcst-to-string'
 import {pointStart} from 'unist-util-position'
 import vfileLocation from 'vfile-location'
 
-var push = [].push
+const push = [].push
 
-var source = convertElement(['code', dataNlcstSourced])
-var ignore = convertElement([
+const source = convertElement(['code', dataNlcstSourced])
+const ignore = convertElement([
   'script',
   'style',
   'svg',
   'math',
   'del',
   dataNlcstIgnore
 ])
-var explicit = convertElement(['p', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6'])
+const explicit = convertElement(['p', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6'])
 
-var flowAccepting = convertElement([
+const flowAccepting = convertElement([
   'body',
   'article',
   'section',
@@ -71,7 +68,7 @@ var flowAccepting = convertElement([
 ])
 
 // See: <https://html.spec.whatwg.org/multipage/dom.html#paragraphs>
-var unravelInParagraph = convertElement(['a', 'ins', 'del', 'map'])
+const unravelInParagraph = convertElement(['a', 'ins', 'del', 'map'])
 
 /**
  * Transform `tree` to nlcst.
@@ -81,15 +78,6 @@ var unravelInParagraph = convertElement(['a', 'ins', 'del', 'map'])
  * @param {ParserInstance|ParserConstructor} Parser
  */
 export function toNlcst(tree, file, Parser) {
-  /** @type {ParserInstance} */
-  var parser
-  /** @type {Location} */
-  var location
-  /** @type {Array.<UnistNode>} */
-  var results
-  /** @type {string} */
-  var doc
-
   // Warn for invalid parameters.
   if (!tree || !tree.type) {
     throw new Error('hast-util-to-nlcst expected node')
@@ -108,13 +96,11 @@ export function toNlcst(tree, file, Parser) {
     throw new Error('hast-util-to-nlcst expected position on nodes')
   }
 
-  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
-  // sentences, paragraphs where needed.
-  results = []
+  const doc = String(file)
+  const location = vfileLocation(doc)
+  const parser = 'parse' in Parser ? Parser : new Parser()
+  /** @type {Array.<UnistNode>} */
+  const results = []
 
   find(tree)
 
@@ -148,7 +134,7 @@ export function toNlcst(tree, file, Parser) {
    * @param {Array.<Child>} children
    */
   function findAll(children) {
-    var index = -1
+    let index = -1
 
     while (++index < children.length) {
       find(children[index])
@@ -161,8 +147,8 @@ export function toNlcst(tree, file, Parser) {
    */
   function flattenAll(children) {
     /** @type {Array.<ElementChild>} */
-    var results = []
-    var index = -1
+    const results = []
+    let index = -1
 
     while (++index < children.length) {
       if (unravelInParagraph(children[index])) {
@@ -182,7 +168,7 @@ export function toNlcst(tree, file, Parser) {
   function add(node) {
     /** @type {Array.<UnistNode>} */
     // @ts-ignore Assume child.
-    var result = Array.isArray(node) ? all(node) : one(node)
+    const result = Array.isArray(node) ? all(node) : one(node)
 
     if (result.length > 0) {
       results.push(parser.tokenizeParagraph(result))
@@ -193,15 +179,13 @@ export function toNlcst(tree, file, Parser) {
    * @param {Array.<ElementChild>} children
    */
   function implicit(children) {
-    var index = -1
-    var start = -1
+    let index = -1
+    let start = -1
     /** @type {boolean} */
-    var viable
-    /** @type {ElementChild} */
-    var child
+    let viable
 
     while (++index <= children.length) {
-      child = children[index]
+      const child = children[index]
 
       if (child && phrasing(child)) {
         if (start === -1) start = index
@@ -233,9 +217,9 @@ export function toNlcst(tree, file, Parser) {
    */
   function one(node) {
     /** @type {Array.<UnistNode>} */
-    var replacement
+    let replacement
     /** @type {boolean} */
-    var change
+    let change
 
     if (node.type === 'text') {
       replacement = parser.tokenize(node.value)
@@ -268,8 +252,8 @@ export function toNlcst(tree, file, Parser) {
    */
   function all(children) {
     /** @type {Array.<UnistNode>} */
-    var results = []
-    var index = -1
+    const results = []
+    let index = -1
 
     while (++index < children.length) {
       push.apply(results, one(children[index]) || [])
@@ -292,22 +276,18 @@ export function toNlcst(tree, file, Parser) {
    * @returns {T}
    */
   function patch(nodes, location, offset) {
-    var index = -1
-    var start = offset
-    /** @type {number} */
-    var end
-    /** @type {UnistNode} */
-    var node
+    let index = -1
+    let start = offset
 
     while (++index < nodes.length) {
-      node = nodes[index]
+      const node = nodes[index]
 
       if ('children' in node) {
         // @ts-ignore Looks like a parent.
         patch(node.children, location, start)
       }
 
-      end = start + nlcstToString(node).length
+      const end = start + nlcstToString(node).length
 
       node.position = {
         start: location.toPoint(start),

package.json

@@ -82,11 +82,7 @@
     "trailingComma": "none"
   },
   "xo": {
-    "prettier": true,
-    "rules": {
-      "no-var": "off",
-      "prefer-arrow-callback": "off"
-    }
+    "prettier": true
   },
   "remarkConfig": {
     "plugins": [

readme.md

@@ -38,14 +38,14 @@ Say we have the following `example.html`:
 …and next to it, `index.js`:
 
 ```js
-import rehype from 'rehype'
-import vfile from 'to-vfile'
-import {ParseEnglish} from 'parse-english'
+import {readSync} from 'to-vfile'
 import {inspect} from 'unist-util-inspect'
 import {toNlcst} from 'hast-util-to-nlcst'
+import {ParseEnglish} from 'parse-english'
+import rehype from 'rehype'
 
-var file = vfile.readSync('example.html')
-var tree = rehype().parse(file)
+const file = readSync('example.html')
+const tree = rehype().parse(file)
 
 console.log(inspect(toNlcst(tree, file, ParseEnglish)))
 ```

test/index.js

@@ -9,9 +9,9 @@ import {ParseEnglish} from 'parse-english'
 import {isHidden} from 'is-hidden'
 import {toNlcst} from '../index.js'
 
-test('hast-util-to-nlcst', function (t) {
+test('hast-util-to-nlcst', (t) => {
   t.throws(
-    function () {
+    () => {
       // @ts-ignore runtime.
       toNlcst()
     },
@@ -20,7 +20,7 @@ test('hast-util-to-nlcst', function (t) {
   )
 
   t.throws(
-    function () {
+    () => {
       // @ts-ignore runtime.
       toNlcst({})
     },
@@ -29,7 +29,7 @@ test('hast-util-to-nlcst', function (t) {
   )
 
   t.throws(
-    function () {
+    () => {
       // @ts-ignore runtime.
       toNlcst({type: 'foo'})
     },
@@ -38,7 +38,7 @@ test('hast-util-to-nlcst', function (t) {
   )
 
   t.throws(
-    function () {
+    () => {
       // @ts-ignore runtime.
       toNlcst({type: 'foo'})
     },
@@ -47,7 +47,7 @@ test('hast-util-to-nlcst', function (t) {
   )
 
   t.throws(
-    function () {
+    () => {
       // @ts-ignore runtime.
       toNlcst({type: 'text', value: 'foo'}, {foo: 'bar'})
     },
@@ -56,7 +56,7 @@ test('hast-util-to-nlcst', function (t) {
   )
 
   t.throws(
-    function () {
+    () => {
       // @ts-ignore runtime.
       toNlcst({type: 'text', value: 'foo'}, vfile('foo'))
     },
@@ -65,14 +65,14 @@ test('hast-util-to-nlcst', function (t) {
   )
 
   t.throws(
-    function () {
+    () => {
       toNlcst({type: 'text', value: 'foo'}, vfile(), ParseLatin)
     },
     /hast-util-to-nlcst expected position on nodes/,
     'should fail when not given positional information'
   )
 
-  t.doesNotThrow(function () {
+  t.doesNotThrow(() => {
     toNlcst(
       {
         type: 'text',
@@ -87,7 +87,7 @@ test('hast-util-to-nlcst', function (t) {
     )
   }, 'should accept a parser constructor')
 
-  t.doesNotThrow(function () {
+  t.doesNotThrow(() => {
     toNlcst(
       {
         type: 'text',
@@ -103,7 +103,7 @@ test('hast-util-to-nlcst', function (t) {
   }, 'should accept a parser instance')
 
   t.throws(
-    function () {
+    () => {
       toNlcst(
         {
           type: 'text',
@@ -119,8 +119,8 @@ test('hast-util-to-nlcst', function (t) {
     'should fail when not given positional information (#2)'
   )
 
-  t.test('should accept nodes without offsets', function (st) {
-    var node = toNlcst(
+  t.test('should accept nodes without offsets', (st) => {
+    const node = toNlcst(
       {
         type: 'text',
         value: 'foo',
@@ -139,8 +139,8 @@ test('hast-util-to-nlcst', function (t) {
     st.end()
   })
 
-  t.test('should accept comments', function (st) {
-    var node = toNlcst(
+  t.test('should accept comments', (st) => {
+    const node = toNlcst(
       {
         type: 'comment',
         value: 'a',
@@ -169,20 +169,20 @@ test('hast-util-to-nlcst', function (t) {
   t.end()
 })
 
-test('Fixtures', function (t) {
-  var root = path.join('test', 'fixtures')
-  var files = fs.readdirSync(root)
-  var index = -1
+test('Fixtures', (t) => {
+  const root = path.join('test', 'fixtures')
+  const files = fs.readdirSync(root)
+  let index = -1
   /** @type {string} */
-  var input
+  let input
   /** @type {string} */
-  var output
+  let output
   /** @type {import('vfile').VFile} */
-  var file
+  let file
   /** @type {import('unist').Node} */
-  var actual
+  let actual
   /** @type {import('unist').Node} */
-  var expected
+  let expected
 
   while (++index < files.length) {
     if (isHidden(files[index])) continue