Refactor code-style

Author: wooorm

lib/index.js

@@ -14,10 +14,10 @@
  * This is because ATX headings with a depth of three or more could be
  * considered setext.
  *
- * @param {Heading} node
+ * @param {Readonly<Heading>} node
  *   Heading node to check.
  * @param {Style | null | undefined} [relative]
- *   Relative style.
+ *   Relative style (preferred style).
  * @returns {Style | null}
  *   Style, if it can be inferred, `null` otherwise.
  */

test.js

@@ -1,125 +1,102 @@
 /**
- * @typedef {import('mdast').Root} Root
  * @typedef {import('mdast').Heading} Heading
  */
 
 import assert from 'node:assert/strict'
 import test from 'node:test'
 import {fromMarkdown} from 'mdast-util-from-markdown'
 import {headingStyle} from './index.js'
-import * as mod from './index.js'
 
-test('headingStyle', () => {
-  assert.deepEqual(
-    Object.keys(mod).sort(),
-    ['headingStyle'],
-    'should expose the public api'
-  )
-
-  assert.throws(() => {
-    // @ts-ignore runtime.
-    headingStyle()
-  }, 'should fail without node')
-
-  assert.equal(
-    // @ts-ignore runtime.
-    headingStyle({
-      type: 'heading',
-      children: [{type: 'text', value: 'foo'}]
-    }),
-    null,
-    'should NOT fail on undetectable nodes'
-  )
-
-  assert.equal(
-    headingStyle(parseFirstNode('# ATX')),
-    'atx',
-    'should detect atx'
-  )
-
-  assert.equal(
-    headingStyle(parseFirstNode('# ATX #')),
-    'atx-closed',
-    'should detect closed atx'
-  )
-
-  assert.equal(
-    headingStyle(parseFirstNode('ATX\n===')),
-    'setext',
-    'should detect closed setext'
-  )
-
-  assert.equal(
-    headingStyle(parseFirstNode('### ATX')),
-    null,
-    'should work on ambiguous nodes'
-  )
-
-  assert.equal(
-    headingStyle(parseFirstNode('### ATX'), 'atx'),
-    'atx',
-    'should work on ambiguous nodes (preference to atx)'
-  )
-
-  assert.equal(
-    headingStyle(parseFirstNode('### ATX'), 'setext'),
-    'setext',
-    'should work on ambiguous nodes (preference to setext)'
-  )
-
-  assert.equal(
-    headingStyle(parseFirstNode('###### ######')),
-    'atx-closed',
-    'should work on empty nodes (#1)'
-  )
-
-  assert.equal(
-    headingStyle(parseFirstNode('### ###')),
-    'atx-closed',
-    'should work on empty nodes (#2)'
-  )
-
-  assert.equal(
-    headingStyle(parseFirstNode('# #')),
-    'atx-closed',
-    'should work on empty nodes (#3)'
-  )
-
-  assert.equal(
-    headingStyle(parseFirstNode('###### '), 'atx'),
-    'atx',
-    'should work on empty nodes (#4)'
-  )
-
-  assert.equal(
-    headingStyle(parseFirstNode('### '), 'atx'),
-    'atx',
-    'should work on empty nodes (#5)'
-  )
-
-  assert.equal(
-    headingStyle(parseFirstNode('## ')),
-    'atx',
-    'should work on empty nodes (#6)'
-  )
-
-  assert.equal(
-    headingStyle(parseFirstNode('###### '), 'setext'),
-    'setext',
-    'should work on empty nodes (#7)'
-  )
-
-  assert.equal(
-    headingStyle(parseFirstNode('### '), 'setext'),
-    'setext',
-    'should work on empty nodes (#8)'
-  )
-
-  assert.equal(
-    headingStyle(parseFirstNode('## '), 'setext'),
-    'atx',
-    'should work on empty nodes (#9)'
-  )
+test('headingStyle', async function (t) {
+  await t.test('should expose the public api', async function () {
+    assert.deepEqual(Object.keys(await import('./index.js')).sort(), [
+      'headingStyle'
+    ])
+  })
+
+  await t.test('should fail without node', async function () {
+    assert.throws(function () {
+      // @ts-expect-error: check that an error is thrown at runtime.
+      headingStyle()
+    })
+  })
+
+  await t.test('should NOT fail on undetectable nodes', async function () {
+    assert.equal(
+      // @ts-expect-error: check that an error is thrown at runtime.
+      headingStyle({
+        type: 'heading',
+        children: [{type: 'text', value: 'foo'}]
+      }),
+      null
+    )
+  })
+
+  await t.test('should detect atx', async function () {
+    assert.equal(headingStyle(parseFirstNode('# ATX')), 'atx')
+  })
+
+  await t.test('should detect closed atx', async function () {
+    assert.equal(headingStyle(parseFirstNode('# ATX #')), 'atx-closed')
+  })
+
+  await t.test('should detect closed setext', async function () {
+    assert.equal(headingStyle(parseFirstNode('ATX\n===')), 'setext')
+  })
+
+  await t.test('should work on ambiguous nodes', async function () {
+    assert.equal(headingStyle(parseFirstNode('### ATX')), null)
+  })
+
+  await t.test(
+    'should work on ambiguous nodes (preference to atx)',
+    async function () {
+      assert.equal(headingStyle(parseFirstNode('### ATX'), 'atx'), 'atx')
+    }
+  )
+
+  await t.test(
+    'should work on ambiguous nodes (preference to setext)',
+    async function () {
+      assert.equal(headingStyle(parseFirstNode('### ATX'), 'setext'), 'setext')
+    }
+  )
+
+  await t.test('should work on empty nodes (#1)', async function () {
+    assert.equal(headingStyle(parseFirstNode('###### ######')), 'atx-closed')
+  })
+
+  await t.test('should work on empty nodes (#2)', async function () {
+    assert.equal(headingStyle(parseFirstNode('### ###')), 'atx-closed')
+  })
+
+  await t.test('should work on empty nodes (#3)', async function () {
+    assert.equal(headingStyle(parseFirstNode('# #')), 'atx-closed')
+  })
+
+  await t.test('should work on empty nodes (#4)', async function () {
+    assert.equal(headingStyle(parseFirstNode('###### '), 'atx'), 'atx')
+  })
+
+  await t.test('should work on empty nodes (#5)', async function () {
+    assert.equal(headingStyle(parseFirstNode('### '), 'atx'), 'atx')
+  })
+
+  await t.test('should work on empty nodes (#6)', async function () {
+    assert.equal(headingStyle(parseFirstNode('## ')), 'atx')
+  })
+
+  await t.test('should work on empty nodes (#7)', async function () {
+    assert.equal(headingStyle(parseFirstNode('###### '), 'setext'), 'setext')
+  })
+
+  await t.test('should work on empty nodes (#8)', async function () {
+    assert.equal(headingStyle(parseFirstNode('### '), 'setext'), 'setext')
+  })
+
+  await t.test('should work on empty nodes (#9)', async function () {
+    assert.equal(headingStyle(parseFirstNode('## '), 'setext'), 'atx')
+  })
 })
 
 /**