Refactor code-style

Author: wooorm

lib/index.js

@@ -1,7 +1,6 @@
 /**
- * @typedef {import('mdast').Parents} Parents
  * @typedef {import('mdast').Nodes} Nodes
- * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Parents} Parents
  */
 
 /**
@@ -45,7 +44,7 @@ import {visit} from 'unist-util-visit'
  *   Comment name to look for.
  * @param {Handler} handler
  *   Handle a section.
- * @returns {void}
+ * @returns {undefined}
  *   Nothing.
  */
 export function zone(node, name, handler) {
@@ -56,10 +55,12 @@ export function zone(node, name, handler) {
   /** @type {Parents | undefined} */
   let scope
 
-  visit(node, (node, index, parent) => {
+  visit(node, function (node, index, parent) {
     const info = commentMarker(node)
     const match =
-      info && info.name === name ? info.attributes.match(/(start|end)\b/) : null
+      info && info.name === name
+        ? info.attributes.match(/(start|end)\b/)
+        : undefined
     const type = match ? match[0] : undefined
 
     if (parent && index !== undefined && type) {
@@ -99,8 +100,12 @@ export function zone(node, name, handler) {
               if (node) result.push(node)
             }
 
-            // @ts-expect-error: Assume the correct children are passed.
-            scope.children.splice(start, index - start + 1, ...result)
+            scope.children.splice(
+              start,
+              index - start + 1,
+              // @ts-expect-error: Assume the correct children are passed.
+              ...result
+            )
           }
 
           marker = undefined

readme.md

@@ -94,12 +94,14 @@ console.log(String(file))
 
 /** @type {import('unified').Plugin<[], import('mdast').Root>} */
 function myPluginThatReplacesFoo() {
-  return (tree) => {
-    zone(tree, 'foo', (start, nodes, end) => [
-      start,
-      {type: 'paragraph', children: [{type: 'text', value: 'Bar.'}]},
-      end
-    ])
+  return function (tree) {
+    zone(tree, 'foo', function (start, nodes, end) {
+      return [
+        start,
+        {type: 'paragraph', children: [{type: 'text', value: 'Bar.'}]},
+        end
+      ]
+    })
   }
 }
 ```
@@ -170,7 +172,7 @@ Extra info (TypeScript type).
     — parent of the section
 *   `start` (`number`)
     — index of `start` in `parent`
-*   `end` (`number` or `null`)
+*   `end` (`number`)
     — index of `end` in `parent`
 
 ## Types

test/fixtures/nodes/index.js

@@ -1,6 +1,5 @@
 /**
  * @typedef {import('mdast').Root} Root
- * @typedef {import('../../../index.js').Handler} Handler
  */
 
 import assert from 'node:assert/strict'

test/fixtures/replace-children/index.js

@@ -11,11 +11,11 @@ export default function assertion(tree) {
   zone(tree, 'foo', function (start, _, end) {
     return [
       start,
-      /** @type {import('mdast').Heading} */ ({
+      {
         type: 'heading',
         depth: 2,
         children: [{type: 'text', value: 'Bar'}]
-      }),
+      },
       end
     ]
   })

test/fixtures/replace/index.js

@@ -8,11 +8,13 @@ import {zone} from '../../../index.js'
  * @param {Root} tree
  */
 export default function assertion(tree) {
-  zone(tree, 'foo', () => [
-    {
-      type: 'heading',
-      depth: 2,
-      children: [{type: 'text', value: 'Bar'}]
-    }
-  ])
+  zone(tree, 'foo', function () {
+    return [
+      {
+        type: 'heading',
+        depth: 2,
+        children: [{type: 'text', value: 'Bar'}]
+      }
+    ]
+  })
 }

test/index.js

@@ -5,17 +5,14 @@
 import assert from 'node:assert/strict'
 import fs from 'node:fs/promises'
 import test from 'node:test'
+import {isHidden} from 'is-hidden'
 import {fromMarkdown} from 'mdast-util-from-markdown'
 import {toMarkdown} from 'mdast-util-to-markdown'
-import {isHidden} from 'is-hidden'
-import * as mod from '../index.js'
 
-test('zone', async () => {
-  assert.deepEqual(
-    Object.keys(mod).sort(),
-    ['zone'],
-    'should expose the public api'
-  )
+test('zone', async function (t) {
+  await t.test('should expose the public api', async function () {
+    assert.deepEqual(Object.keys(await import('../index.js')).sort(), ['zone'])
+  })
 
   const root = new URL('fixtures/', import.meta.url)
   const folders = await fs.readdir(root)
@@ -26,26 +23,30 @@ test('zone', async () => {
 
     if (isHidden(folder)) continue
 
-    /** @type {string | undefined} */
-    let expected
+    await t.test('should work on `' + folder + '`', async function () {
+      /** @type {string | undefined} */
+      let expected
 
-    try {
-      expected = String(await fs.readFile(new URL(folder + '/output.md', root)))
-    } catch {}
+      try {
+        expected = String(
+          await fs.readFile(new URL(folder + '/output.md', root))
+        )
+      } catch {}
 
-    /** @type {{default: (tree: Root) => void}} */
-    const mod = await import(new URL(folder + '/index.js', root).href)
-    const check = mod.default
-    // To do: remove cast when `from-markdown` is released.
-    const tree = /** @type {Root} */ (
-      fromMarkdown(await fs.readFile(new URL(folder + '/input.md', root)))
-    )
+      /** @type {{default: (tree: Root) => undefined}} */
+      const mod = await import(new URL(folder + '/index.js', root).href)
+      const check = mod.default
+      // To do: remove cast when `from-markdown` is released.
+      const tree = /** @type {Root} */ (
+        fromMarkdown(await fs.readFile(new URL(folder + '/input.md', root)))
+      )
 
-    check(tree)
+      check(tree)
 
-    // @ts-expect-error: remove cast when `to-markdown` is released.
-    const result = toMarkdown(tree)
+      // @ts-expect-error: remove cast when `to-markdown` is released.
+      const result = toMarkdown(tree)
 
-    assert.equal(result, expected, folder)
+      assert.equal(result, expected)
+    })
   }
 })