Refactor code-style

Author: wooorm

lib/index.js

@@ -2,12 +2,14 @@
  * @typedef {import('@rgrove/parse-xml').XmlCdata} XmlCdata
  * @typedef {import('@rgrove/parse-xml').XmlComment} XmlComment
  * @typedef {import('@rgrove/parse-xml').XmlDeclaration} XmlDeclaration
+ * @typedef {import('@rgrove/parse-xml').XmlError} XmlError
  * @typedef {import('@rgrove/parse-xml').XmlDocument} XmlDocument
  * @typedef {import('@rgrove/parse-xml').XmlDocumentType} XmlDocumentType
  * @typedef {import('@rgrove/parse-xml').XmlElement} XmlElement
  * @typedef {import('@rgrove/parse-xml').XmlProcessingInstruction} XmlProcessingInstruction
  * @typedef {import('@rgrove/parse-xml').XmlText} XmlText
- * @typedef {import('@rgrove/parse-xml').XmlError} XmlError
+ *
+ * @typedef {import('vfile-location').Location} Location
  *
  * @typedef {import('xast').Cdata} Cdata
  * @typedef {import('xast').Comment} Comment
@@ -28,7 +30,7 @@
  *
  * @typedef State
  *   Info passed around.
- * @property {ReturnType<location>} location
+ * @property {Location} location
  *   Interface to translate between offsets and points.
  */
 
@@ -39,7 +41,7 @@ import {VFileMessage} from 'vfile-message'
 /**
  * Parse a string of XML to a xast tree.
  *
- * @param {string | Uint8Array} value
+ * @param {Uint8Array | string} value
  *   Serialized XML.
  * @returns {Root}
  *   xast root.
@@ -271,7 +273,7 @@ function transformChildren(children, state) {
  *   xast node.
  * @param {State} state
  *   Info passed around.
- * @returns {void}
+ * @returns {undefined}
  *   Nothing.
  */
 function patch(from, to, state) {

readme.md

@@ -83,7 +83,7 @@ import {fromXml} from 'xast-util-from-xml'
 
 const tree = fromXml(await fs.readFile('example.xml'))
 
-console.dir(tree, {depth: null})
+console.dir(tree, {depth: undefined})
 ```
 
 …now running `node example.js` yields (positional info removed for brevity):

test/index.js

@@ -8,72 +8,61 @@ import process from 'node:process'
 import test from 'node:test'
 import {isHidden} from 'is-hidden'
 import {fromXml} from '../index.js'
-import * as mod from '../index.js'
 
-test('fromXml', () => {
-  assert.deepEqual(
-    Object.keys(mod).sort(),
-    ['fromXml'],
-    'should expose the public api'
-  )
+test('fromXml', async function (t) {
+  await t.test('should expose the public api', async function () {
+    assert.deepEqual(Object.keys(await import('../index.js')).sort(), [
+      'fromXml'
+    ])
+  })
 
-  try {
-    fromXml('<root unquoted=attribute>')
-    assert.fail('should fail (1)')
-  } catch (error) {
-    assert.match(
-      String(error),
-      /^1:16: Attribute value expected/,
-      'should throw messages'
-    )
-  }
+  await t.test('should throw messages', async function () {
+    try {
+      fromXml('<root unquoted=attribute>')
+      assert.fail()
+    } catch (error) {
+      assert.match(String(error), /^1:16: Attribute value expected/)
+    }
+  })
 
-  try {
-    fromXml('<!ENTITY>')
-    assert.fail('should fail (2)')
-  } catch (error) {
-    assert.match(
-      String(error),
-      /^1:1: Root element is missing or invalid/,
-      'should throw for SGML directives'
-    )
-  }
+  await t.test('should throw for SGML directives', async function () {
+    try {
+      fromXml('<!ENTITY>')
+      assert.fail()
+    } catch (error) {
+      assert.match(String(error), /^1:1: Root element is missing or invalid/)
+    }
+  })
 
-  try {
-    fromXml('<root>&foo;</root>')
-    assert.fail('should fail (3)')
-  } catch (error) {
-    assert.match(
-      String(error),
-      /^1:7: Named entity isn't defined/,
-      'should throw for unknown entities (1)'
-    )
-  }
+  await t.test('should throw for unknown entities (1)', async function () {
+    try {
+      fromXml('<root>&foo;</root>')
+      assert.fail()
+    } catch (error) {
+      assert.match(String(error), /^1:7: Named entity isn't defined/)
+    }
+  })
 
-  try {
-    fromXml('<root>&copy;</root>')
-    assert.fail('should fail (4)')
-  } catch (error) {
-    assert.match(
-      String(error),
-      /^1:7: Named entity isn't defined/,
-      'should throw for unknown entities (2)'
-    )
-  }
+  await t.test('should throw for unknown entities (2)', async function () {
+    try {
+      fromXml('<root>&copy;</root>')
+      assert.fail()
+    } catch (error) {
+      assert.match(String(error), /^1:7: Named entity isn't defined/)
+    }
+  })
 
-  try {
-    fromXml('<root><a><b><c/></a></b></root>')
-    assert.fail('should fail (5)')
-  } catch (error) {
-    assert.match(
-      String(error),
-      /^1:17: Missing end tag for element/,
-      'should throw on invalid nesting'
-    )
-  }
+  await t.test('should throw on invalid nesting', async function () {
+    try {
+      fromXml('<root><a><b><c/></a></b></root>')
+      assert.fail()
+    } catch (error) {
+      assert.match(String(error), /^1:17: Missing end tag for element/)
+    }
+  })
 })
 
-test('fixtures', async () => {
+test('fixtures', async function (t) {
   const base = new URL('fixtures/', import.meta.url)
   const files = await fs.readdir(base)
   let index = -1
@@ -83,27 +72,29 @@ test('fixtures', async () => {
 
     if (isHidden(folder)) continue
 
-    const inputUrl = new URL(folder + '/index.xml', base)
-    const treeUrl = new URL(folder + '/index.json', base)
-    const input = await fs.readFile(inputUrl)
-    /** @type {Root} */
-    // Remove `undefined`s.
-    const actual = JSON.parse(JSON.stringify(fromXml(input)))
-    /** @type {Root} */
-    let expected
+    await t.test(folder, async function () {
+      const inputUrl = new URL(folder + '/index.xml', base)
+      const treeUrl = new URL(folder + '/index.json', base)
+      const input = await fs.readFile(inputUrl)
+      /** @type {Root} */
+      // Remove `undefined`s.
+      const actual = JSON.parse(JSON.stringify(fromXml(input)))
+      /** @type {Root} */
+      let expected
 
-    try {
-      expected = JSON.parse(String(await fs.readFile(treeUrl)))
+      try {
+        expected = JSON.parse(String(await fs.readFile(treeUrl)))
 
-      if ('UPDATE' in process.env) {
-        throw new Error('Update')
+        if ('UPDATE' in process.env) {
+          throw new Error('Update')
+        }
+      } catch {
+        // New folder.
+        await fs.writeFile(treeUrl, JSON.stringify(actual, undefined, 2) + '\n')
+        return
       }
-    } catch {
-      // New folder.
-      await fs.writeFile(treeUrl, JSON.stringify(actual, null, 2) + '\n')
-      continue
-    }
 
-    assert.deepEqual(actual, expected, folder)
+      assert.deepEqual(actual, expected)
+    })
   }
 })