api-links: add test fixtures

Signed-off-by: flakey5 <[email protected]>

Author: flakey5

.prettierignore

@@ -0,0 +1 @@
+src/generators/api-links/test/fixtures/

eslint.config.mjs

@@ -47,4 +47,7 @@ export default [
   // @see https://eslint.org/docs/latest/rules to learn more about these rules
   pluginJs.configs.recommended,
   eslintConfigPrettier,
+  {
+    ignores: ['src/generators/api-links/test/fixtures/**'],
+  },
 ];

package.json

@@ -5,8 +5,8 @@
     "url": "git+https://github.com/nodejs/api-docs-tooling.git"
   },
   "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint --fix .",
+    "lint": "eslint . --no-warn-ignored",
+    "lint:fix": "eslint --fix . --no-warn-ignored",
     "format": "prettier .",
     "format:write": "prettier --write .",
     "test": "node --test",

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

@@ -0,0 +1,47 @@
+import { equal, notStrictEqual, ok } from 'node:assert';
+import { describe, it } from 'node:test';
+import { readFile, readdir } from 'node:fs/promises';
+import { basename, extname, join } from 'node:path';
+import astJs from '../../ast-js/index.mjs';
+import apiLinks from '../index.mjs';
+
+const FIXTURES_DIRECTORY = join(import.meta.dirname, 'fixtures');
+const fixtures = await readdir(FIXTURES_DIRECTORY);
+
+const sourceFiles = fixtures
+  .filter(fixture => extname(fixture) === '.js')
+  .map(fixture => join(FIXTURES_DIRECTORY, fixture));
+
+describe('api links', () => {
+  describe('should work correctly for all fixtures', () => {
+    sourceFiles.forEach(sourceFile => {
+      it(`${basename(sourceFile)}`, async () => {
+        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];
+        }
+
+        equal(
+          Object.keys(actualOutput).length,
+          0,
+          'actual output has extra keys'
+        );
+      });
+    });
+  });
+});

src/generators/api-links/test/fixtures/buffer.js

@@ -0,0 +1,12 @@
+'use strict';
+
+// Buffer instance methods are exported as 'buf'.
+
+function Buffer() {
+}
+
+Buffer.prototype.instanceMethod = function() {}
+
+module.exports = {
+  Buffer
+};

src/generators/api-links/test/fixtures/buffer.json

@@ -0,0 +1,4 @@
+{
+  "buffer.Buffer": "buffer.js#L5",
+  "buf.instanceMethod": "buffer.js#L8"
+}

src/generators/api-links/test/fixtures/class.js

@@ -0,0 +1,12 @@
+'use strict';
+
+// An exported class using ES2015 class syntax.
+
+class Class {
+  constructor() {};
+  method() {};
+}
+
+module.exports = {
+  Class
+};

src/generators/api-links/test/fixtures/class.json

@@ -0,0 +1,5 @@
+{
+  "Class": "class.js#L5",
+  "new Class": "class.js#L6",
+  "class.method": "class.js#L7"
+}

src/generators/api-links/test/fixtures/exports.js

@@ -0,0 +1,13 @@
+'use strict';
+
+// Support `exports` as an alternative to `module.exports`.
+
+function Buffer() {};
+
+exports.Buffer = Buffer;
+exports.fn1 = function fn1() {};
+
+var fn2 = exports.fn2 = function() {};
+
+function fn3() {};
+exports.fn3 = fn3;

src/generators/api-links/test/fixtures/exports.json

@@ -0,0 +1,6 @@
+{
+  "exports.Buffer": "exports.js#L5",
+  "exports.fn1": "exports.js#L8",
+  "exports.fn2": "exports.js#L10",
+  "exports.fn3": "exports.js#L12"
+}