Refactor code-style

Author: wooorm

lib/index.js

@@ -1,9 +1,10 @@
 /**
- * @typedef {import('mdast').Root} Root
  * @typedef {import('mdast').Content} Content
  * @typedef {import('mdast').Heading} Heading
+ * @typedef {import('mdast').Root} Root
  */
 
+// To do: when `mdast` is released, use `Nodes`.
 /**
  * @typedef {Content | Root} Node
  */
@@ -34,7 +35,7 @@ export function normalizeHeadings(tree) {
   /** @type {Heading | undefined} */
   let title
 
-  visit(tree, 'heading', (node) => {
+  visit(tree, 'heading', function (node) {
     all.push(node)
 
     if (!first) {

package.json

@@ -82,6 +82,16 @@
     "strict": true
   },
   "xo": {
+    "overrides": [
+      {
+        "files": [
+          "test/**/*.js"
+        ],
+        "rules": {
+          "no-await-in-loop": "off"
+        }
+      }
+    ],
     "prettier": true
   }
 }

test/index.js

@@ -8,41 +8,40 @@ import test from 'node:test'
 import {fromMarkdown} from 'mdast-util-from-markdown'
 import {removePosition} from 'unist-util-remove-position'
 import {normalizeHeadings} from '../index.js'
-import * as mod from '../index.js'
 
-test('normalizeHeadings', async () => {
-  assert.deepEqual(
-    Object.keys(mod).sort(),
-    ['normalizeHeadings'],
-    'should expose the public api'
-  )
+test('normalizeHeadings', async function (t) {
+  await t.test('should expose the public api', async function () {
+    assert.deepEqual(Object.keys(await import('../index.js')).sort(), [
+      'normalizeHeadings'
+    ])
+  })
 
-  await check('no-headings', 'No-op if there is no headings')
-  await check('no-titles', 'No-op if there is no top-level headings')
-  await check('one-title', 'No-op if there is a single top-level heading')
-  await check('two-titles', 'Makes the second header one level deeper')
-  await check('more-titles', 'Shifts all other headings one level deeper')
-  await check('hierarchy', 'There is no depth level 7')
-})
-/**
- * @param {string} test
- * @param {string} message
- * @returns {Promise<void>}
- */
-async function check(test, message) {
-  const input = await fs.readFile(
-    new URL('fixture/' + test + '.in', import.meta.url)
-  )
-  const output = await fs.readFile(
-    new URL('fixture/' + test + '.out', import.meta.url)
-  )
-  const actual = fromMarkdown(input)
-  const expected = fromMarkdown(output)
-  normalizeHeadings(actual)
+  /** @type {Record<string, string>} */
+  const cases = {
+    'no-headings': 'should be a no-op if there are no headings',
+    'no-titles': 'should be a no-op if there are no top-level headings',
+    'one-title': 'should be a no-op if there is a single top-level heading',
+    'two-titles': 'should make the second header one level deeper',
+    'more-titles': 'should shift all other headings one level deeper',
+    hierarchy: 'should be create a depth level 7'
+  }
 
-  assert.deepEqual(
-    removePosition(actual, true),
-    removePosition(expected, true),
-    message
-  )
-}
+  for (const [name, message] of Object.entries(cases)) {
+    await t.test(message, async function () {
+      const input = await fs.readFile(
+        new URL('fixture/' + name + '.in', import.meta.url)
+      )
+      const output = await fs.readFile(
+        new URL('fixture/' + name + '.out', import.meta.url)
+      )
+      const actual = fromMarkdown(input)
+      const expected = fromMarkdown(output)
+      normalizeHeadings(actual)
+
+      assert.deepEqual(
+        removePosition(actual, true),
+        removePosition(expected, true)
+      )
+    })
+  }
+})