Refactor to use node:test

Author: wooorm

package.json

@@ -43,14 +43,13 @@
     "unified": "^10.0.0"
   },
   "devDependencies": {
-    "@types/tape": "^5.0.0",
+    "@types/node": "^20.0.0",
     "c8": "^8.0.0",
     "is-hidden": "^2.0.0",
     "prettier": "^3.0.0",
     "remark": "^14.0.0",
     "remark-cli": "^11.0.0",
     "remark-preset-wooorm": "^9.0.0",
-    "tape": "^5.0.0",
     "type-coverage": "^2.0.0",
     "typescript": "^5.0.0",
     "xo": "^0.56.0"
@@ -83,6 +82,16 @@
     "strict": true
   },
   "xo": {
+    "overrides": [
+      {
+        "files": [
+          "test/**/*.js"
+        ],
+        "rules": {
+          "no-await-in-loop": "off"
+        }
+      }
+    ],
     "prettier": true
   }
 }

test/index.js

@@ -2,44 +2,62 @@
  * @typedef {import('../index.js').Options} Options
  */
 
-import fs from 'node:fs'
-import path from 'node:path'
-import test from 'tape'
+import assert from 'node:assert/strict'
+import fs from 'node:fs/promises'
+import process from 'node:process'
+import test from 'node:test'
 import {remark} from 'remark'
 import {isHidden} from 'is-hidden'
 import remarkToc from '../index.js'
 
-test('Fixtures', (t) => {
-  const root = path.join('test', 'fixtures')
-  const fixtures = fs.readdirSync(root)
+test('remarkToc', async function (t) {
+  const base = new URL('fixtures/', import.meta.url)
+  const folders = await fs.readdir(base)
+
   let index = -1
 
-  while (++index < fixtures.length) {
-    const fixture = fixtures[index]
+  while (++index < folders.length) {
+    const folder = folders[index]
+
+    if (isHidden(folder)) continue
 
-    if (isHidden(fixture)) {
-      continue
-    }
+    await t.test(folder, async function () {
+      const folderUrl = new URL(folder + '/', base)
+      const inputUrl = new URL('input.md', folderUrl)
+      const outputUrl = new URL('output.md', folderUrl)
+      const configUrl = new URL('config.json', folderUrl)
 
-    /** @type {Options} */
-    let config = {}
+      const input = String(await fs.readFile(inputUrl))
 
-    try {
-      config = JSON.parse(
-        String(fs.readFileSync(path.join(root, fixture, 'config.json')))
-      )
-    } catch {}
+      /** @type {Options | undefined} */
+      let config
+      /** @type {string} */
+      let output
 
-    t.equal(
-      remark()
+      try {
+        config = JSON.parse(String(await fs.readFile(configUrl)))
+      } catch {}
+
+      const proc = remark()
+        // To do: use defaults.
         .use({settings: {bullet: '-'}})
+        // @ts-expect-error: to do: fix type.
         .use(remarkToc, config)
-        .processSync(fs.readFileSync(path.join(root, fixture, 'input.md')))
-        .toString(),
-      String(fs.readFileSync(path.join(root, fixture, 'output.md'))),
-      'should work on `' + fixture + '`'
-    )
-  }
 
-  t.end()
+      const actual = String(await proc.process(input))
+
+      try {
+        if ('UPDATE' in process.env) {
+          throw new Error('Updating…')
+        }
+
+        output = String(await fs.readFile(outputUrl))
+      } catch {
+        output = actual
+        await fs.writeFile(outputUrl, actual)
+      }
+
+      assert.equal(actual, String(output))
+    })
+  }
 })