use snapshot api

Author: AugustinMauroy

.prettierignore

@@ -1 +1,3 @@
+# Tests files
 src/generators/api-links/test/fixtures/
+*.snapshot

package.json

@@ -10,8 +10,9 @@
     "format": "prettier .",
     "format:write": "prettier --write .",
     "test": "node --test",
-    "test:watch": "node --test --watch",
     "test:coverage": "node --experimental-test-coverage --test",
+    "test:update-snapshots": "node --test --test-update-snapshots",
+    "test:watch": "node --test --watch",
     "prepare": "husky",
     "run": "node bin/cli.mjs",
     "watch": "node --watch bin/cli.mjs"

src/generators/api-links/test/fixtures.test.mjs

@@ -1,6 +1,5 @@
-import { equal, notStrictEqual, ok } from 'node:assert';
 import { describe, it } from 'node:test';
-import { readFile, readdir } from 'node:fs/promises';
+import { readdir } from 'node:fs/promises';
 import { basename, extname, join } from 'node:path';
 import astJs from '../../ast-js/index.mjs';
 import apiLinks from '../index.mjs';
@@ -15,32 +14,17 @@ const sourceFiles = fixtures
 describe('api links', () => {
   describe('should work correctly for all fixtures', () => {
     sourceFiles.forEach(sourceFile => {
-      it(`${basename(sourceFile)}`, async () => {
+      it(`${basename(sourceFile)}`, async t => {
         const astJsResult = await astJs.generate(undefined, {
           input: [sourceFile],
         });
 
         const actualOutput = await apiLinks.generate(astJsResult, {});
-
-        const expectedOutput = JSON.parse(
-          await readFile(sourceFile.replace('.js', '.json'), 'utf8')
-        );
-
-        for (const [k, v] of Object.entries(expectedOutput)) {
-          notStrictEqual(actualOutput[k], undefined, `missing ${k}`);
-          ok(
-            actualOutput[k].endsWith(`/${v}`),
-            `expected ${v}, got ${actualOutput[k]}`
-          );
-
-          delete actualOutput[k];
+        for (const [k, v] of Object.entries(actualOutput)) {
+          actualOutput[k] = v.replace(/.*(?=lib\/)/, '');
         }
 
-        equal(
-          Object.keys(actualOutput).length,
-          0,
-          'actual output has extra keys'
-        );
+        t.assert.snapshot(actualOutput);
       });
     });
   });

src/generators/api-links/test/fixtures.test.mjs.snapshot

@@ -0,0 +1,49 @@
+exports[`api links > should work correctly for all fixtures > buffer.js 1`] = `
+{
+  "buffer.Buffer": "lib/buffer.js#L5",
+  "buf.instanceMethod": "lib/buffer.js#L8"
+}
+`;
+
+exports[`api links > should work correctly for all fixtures > class.js 1`] = `
+{
+  "Class": "lib/class.js#L5",
+  "new Class": "lib/class.js#L6",
+  "class.method": "lib/class.js#L7"
+}
+`;
+
+exports[`api links > should work correctly for all fixtures > exports.js 1`] = `
+{
+  "exports.fn1": "lib/exports.js#L8",
+  "exports.fn2": "lib/exports.js#L10",
+  "exports.Buffer": "lib/exports.js#L5",
+  "exports.fn3": "lib/exports.js#L12"
+}
+`;
+
+exports[`api links > should work correctly for all fixtures > mod.js 1`] = `
+{
+  "mod.foo": "lib/mod.js#L5"
+}
+`;
+
+exports[`api links > should work correctly for all fixtures > prototype.js 1`] = `
+{
+  "prototype.Class": "lib/prototype.js#L5",
+  "Class.classMethod": "lib/prototype.js#L8",
+  "class.instanceMethod": "lib/prototype.js#L9"
+}
+`;
+
+exports[`api links > should work correctly for all fixtures > reverse.js 1`] = `
+{
+  "asserts": "lib/reverse.js#L8",
+  "asserts.ok": "lib/reverse.js#L5",
+  "asserts.strictEqual": "lib/reverse.js#L12"
+}
+`;
+
+exports[`api links > should work correctly for all fixtures > root.js 1`] = `
+{}
+`;