chore(all): replace Jest with Mocha and Node's assert module

Author: tgreyuk

.github/workflows/ci.yml

@@ -11,6 +11,7 @@ on:
       - main
       - release
       - beta
+      - remove-jest
   pull_request:
     paths:
       - 'packages/typedoc-plugin-markdown/**'

devtools/packages/testing/assertions.ts

@@ -0,0 +1,13 @@
+import assert from 'assert';
+import { diff } from 'jest-diff';
+import { getSnapshot } from './helpers.js';
+
+export function assertToMatchSnapshot(name: string, actual: string | string[]) {
+  const snapshot = getSnapshot(name, actual);
+  try {
+    assert.strictEqual(actual, snapshot);
+  } catch (error) {
+    console.error(diff(actual, snapshot));
+    throw error;
+  }
+}

devtools/packages/testing/helpers.ts

@@ -0,0 +1,31 @@
+import fs from 'fs-extra';
+import path from 'path';
+
+export function getSnapshot(name: string, actual: string | string[]) {
+  const snapshotDir = `${process.cwd()}/test/__snapshots__`;
+  const snapshotPath = path.join(snapshotDir, `${name}.snap`);
+
+  if (!fs.existsSync(snapshotPath)) {
+    fs.outputFileSync(snapshotPath, serialize(actual));
+    return actual;
+  }
+
+  return fs.readFileSync(snapshotPath, 'utf-8');
+}
+
+export function getFileContents(filePath: string) {
+  const fullFilePath = `${process.cwd()}/test/${filePath}`;
+  return fs.readFileSync(fullFilePath).toString();
+}
+
+export function getDirContents(dirPath: string) {
+  const fullDirPath = `${process.cwd()}/test/${dirPath}`;
+  return JSON.stringify(fs.readdirSync(fullDirPath), null, 2);
+}
+
+export function serialize(content: string | string[]) {
+  if (Array.isArray(content)) {
+    return JSON.stringify(content, null, 2);
+  }
+  return content;
+}

devtools/packages/testing/index.ts

@@ -1,130 +1,2 @@
-import * as fs from 'fs';
-import * as path from 'path';
-
-export function expectFileToEqual(
-  key: string,
-  outputFileStrategy: 'modules' | 'members' | ('modules' | 'members')[],
-  file: string | string[],
-  limit?: number,
-  range?: Array<number>,
-) {
-  const outputFileStrategies = Array.isArray(outputFileStrategy)
-    ? outputFileStrategy
-    : [outputFileStrategy];
-  outputFileStrategies.forEach((outputFileStrategy) => {
-    const basePath = getOutputFileStrategyPath(key, outputFileStrategy);
-
-    const optionDirs = fs.readdirSync(basePath);
-    optionDirs.forEach((optionDir, index) => {
-      const isArray = Array.isArray(file);
-      if (index < file.length) {
-        if (!limit || limit > index) {
-          const fullPath = path.join(
-            basePath,
-            optionDir,
-            isArray ? file[index] : file,
-          );
-          let actual = fs.readFileSync(fullPath).toString();
-          if (range) {
-            actual = actual.split('\n').slice(range[0], range[1]).join('\n');
-          }
-          expect(actual).toMatchSnapshot(
-            `(Output File Strategy "${outputFileStrategy}") (Option Group "${
-              index + 1
-            }")`,
-          );
-        }
-      }
-    });
-  });
-}
-
-export function expectUrlsToEqual(
-  outDir: string,
-  outputFileStrategies: ('members' | 'modules')[],
-) {
-  outputFileStrategies.forEach((outputFileStrategy) => {
-    const basePath = getOutputFileStrategyPath(outDir, outputFileStrategy);
-    const optionDirs = fs.readdirSync(basePath);
-    optionDirs.forEach((optionDir) => {
-      const optionsBasePath = path.join(basePath, optionDir);
-      const rootDirectory = fs.readdirSync(path.join(basePath, optionDir));
-      const reduceDirectory = (
-        basePath: string,
-        baseDirectory: string,
-        directory: string[],
-      ) => {
-        return directory.reduce((prev: any, item) => {
-          if (fs.lstatSync(`${basePath}/${item}`).isDirectory()) {
-            const nestedDir = fs.readdirSync(`${basePath}/${item}`);
-            return [
-              ...prev,
-              ...reduceDirectory(
-                `${basePath}/${item}`,
-                `${baseDirectory}/${item}`,
-                nestedDir,
-              ),
-            ];
-          }
-          if (path.extname(item) === '.json') {
-            return prev;
-          }
-          return [...prev, `${baseDirectory}/${item}`.replace(/^\/+/, '')];
-        }, []);
-      };
-      const urls = reduceDirectory(optionsBasePath, '', rootDirectory);
-      expect(urls).toMatchSnapshot(`outputFileStrategy: ${outputFileStrategy}`);
-    });
-  });
-}
-
-export function getOutDir() {
-  return path.join(process.cwd(), 'test', 'fixtures', 'out');
-}
-
-export function expectDirToEqual(outDir: string) {
-  const basePath = getPath(outDir);
-  const rootDirectory = fs.readdirSync(path.join(basePath));
-  const reduceDirectory = (
-    basePath: string,
-    baseDirectory: string,
-    directory: string[],
-  ) => {
-    return directory.reduce((prev: any, item) => {
-      if (fs.lstatSync(`${basePath}/${item}`).isDirectory()) {
-        const nestedDir = fs.readdirSync(`${basePath}/${item}`);
-        return [
-          ...prev,
-          ...reduceDirectory(
-            `${basePath}/${item}`,
-            `${baseDirectory}/${item}`,
-            nestedDir,
-          ),
-        ];
-      }
-      return [...prev, `${baseDirectory}/${item}`.replace(/^\/+/, '')];
-    }, []);
-  };
-  const urls = reduceDirectory(basePath, '', rootDirectory);
-  expect(urls).toMatchSnapshot(`dir: ${outDir}`);
-}
-
-function getPath(dir: string) {
-  return path.join(process.cwd(), 'test', 'fixtures', 'out', dir);
-}
-
-function getOutputFileStrategyPath(
-  key: string,
-  outputFileStrategy: 'modules' | 'members',
-) {
-  const basePath = path.join(
-    process.cwd(),
-    'test',
-    'fixtures',
-    'out',
-    'md',
-    key,
-    outputFileStrategy,
-  );
-  return basePath;
-}
+export * from './assertions.js';
+export * from './helpers.js';

devtools/packages/testing/package.json

@@ -2,6 +2,7 @@
   "name": "@devtools/testing",
   "version": "0.0.0",
   "private": true,
+  "type": "module",
   "main": "index.ts",
   "files": [
     "/"