@markedjs/testutils 17.0.1-0 → 17.0.1-1

package/package.json

@@ -1,16 +1,28 @@
 {
   "name": "@markedjs/testutils",
-  "version": "17.0.1-0",
+  "version": "17.0.1-1",
   "description": "Test utilities for marked and marked extensions",
-  "main": "src/index.js",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./lib/index.js",
+      "types": "./lib/index.d.ts"
+    }
+  },
   "type": "module",
   "scripts": {
-    "test": "node --test",
+    "build": "tsc",
+    "test": "npm run build && node --import tsx --test test/*.test.ts",
     "test:lint": "eslint .",
     "test:format": "prettier . --check",
+    "test:types": "attw --pack . --ignore-rules=cjs-resolves-to-esm",
     "lint": "eslint . --fix",
     "format": "prettier . --write"
   },
+  "files": [
+    "lib/"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/markedjs/testutils.git"
@@ -22,15 +34,19 @@
   },
   "homepage": "https://github.com/markedjs/testutils#readme",
   "dependencies": {
-    "@markedjs/html-differ": "^5.0.3",
+    "@markedjs/html-differ": "^5.0.4",
     "front-matter": "^4.0.2",
     "marked": "17.0.1",
     "marked-repo": "https://github.com/markedjs/marked/tarball/v17.0.1"
   },
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.2",
     "@eslint/js": "^9.33.0",
-    "eslint": "^9.39.1",
+    "@types/node": "^22.10.2",
+    "eslint": "^9.39.2",
     "globals": "^16.5.0",
-    "prettier": "^3.6.2"
+    "prettier": "^3.7.4",
+    "tsx": "^4.7.1",
+    "typescript": "^5.7.2"
   }
 }

package/.github/dependabot.yml

@@ -1,11 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-  - package-ecosystem: "npm"
-    versioning-strategy: "increase"
-    directory: "/"
-    schedule:
-      interval: "weekly"

package/.github/workflows/automerge.yml

@@ -1,39 +0,0 @@
-name: "Automerge"
-on:
-  workflow_run:
-    workflows:
-      - Tests
-    types:
-      - completed
-
-jobs:
-  Automerge:
-    runs-on: ubuntu-latest
-    if: |
-      github.event.workflow_run.event == 'pull_request' &&
-      github.event.workflow_run.conclusion == 'success'
-    steps:
-      - name: "Merge PR"
-        uses: actions/github-script@v8
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          script: |
-            const pr = await github.rest.pulls.get({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              pull_number: context.payload.workflow_run.pull_requests[0].number,
-            });
-            if (pr.data.title.includes('marked')) {
-              console.log('Not Merged 🚫');
-              console.log(`Must update marked-repo as well`);
-            } else if (pr.data.user.login !== 'dependabot[bot]') {
-              console.log('Not Merged 🚫');
-              console.log(`User '${pr.data.user.login}' does not equal 'dependabot[bot]'`);
-            } else {
-              await github.rest.pulls.merge({
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                pull_number: context.payload.workflow_run.pull_requests[0].number,
-              });
-              console.log('Merged 🎉');
-            }

package/.github/workflows/tests.yml

@@ -1,87 +0,0 @@
-name: "Tests"
-on:
-  pull_request:
-  push:
-    branches:
-      - main
-
-permissions:
-  contents: read
-
-jobs:
-  Test:
-    strategy:
-      matrix:
-        node_version: ["lts/*", "*"]
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v6
-      - name: Install Node
-        uses: actions/setup-node@v6
-        with:
-          node-version: ${{ matrix.node_version }}
-          check-latest: true
-      - name: Install Dependencies
-        run: npm ci
-      - name: Test 👩🏽‍💻
-        run: npm run test
-
-  Lint:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v6
-      - name: Install Node
-        uses: actions/setup-node@v6
-        with:
-          node-version: "lts/*"
-      - name: Install Dependencies
-        run: npm ci
-      - name: Lint ✨
-        run: npm run test:lint
-
-  Format:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v6
-      - name: Install Node
-        uses: actions/setup-node@v6
-        with:
-          node-version: "lts/*"
-      - name: Install Dependencies
-        run: npm ci
-      - name: Format 💖
-        run: npm run test:format
-
-  Release:
-    # This will only work if the version in package.json is updated
-    needs: [Test, Lint, Format]
-    if: |
-      github.ref == 'refs/heads/main' &&
-      github.event.repository.fork == false
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v6
-      - name: Install Node
-        uses: actions/setup-node@v6
-        with:
-          node-version: "lts/*"
-          registry-url: https://registry.npmjs.org/
-      - name: Install Dependencies
-        run: npm ci
-      - name: Publish 📝
-        run: |
-          PUBLISHED=$(npm info @markedjs/testutils version)
-          CURRENT=$(node -p "require('./package.json').version")
-          echo "$PUBLISHED -> $CURRENT"
-          if [ $PUBLISHED != $CURRENT ]
-          then
-            npm publish --tag latest
-          else
-            echo "No new version"
-          fi
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/eslint.config.js

@@ -1,18 +0,0 @@
-import js from "@eslint/js";
-import globals from "globals";
-
-export default [
-  js.configs.recommended,
-  {
-    languageOptions: {
-      globals: {
-        ...globals.node,
-        ...globals.es2021,
-      },
-      parserOptions: {
-        ecmaVersion: "latest",
-        sourceType: "module",
-      },
-    },
-  },
-];

package/src/get-tests.js

@@ -1,43 +0,0 @@
-import { loadTests } from "./load-tests.js";
-import { resolve } from "node:path";
-
-/**
- * Get tests from a directory or file
- * @param {string | string[]} dirs Can be a string or an array of strings
- * @returns {Tests | Tests[]} The return type will match the input, a tests object or an array of tests objects
- */
-export async function getTests(dirs) {
-  if (Array.isArray(dirs)) {
-    return await Promise.all(dirs.map((dir) => loadTests(dir)));
-  }
-
-  return await loadTests(dirs);
-}
-
-/**
- * Get all marked tests
- * @returns {{
- *   CommonMark: Tests,
- *   GFM: Tests,
- *   New: Tests,
- *   Original: Tests,
- *   ReDOS: Tests,
- * }} All marked spec tests
- */
-export async function getAllMarkedSpecTests() {
-  const tests = await getTests([
-    resolve("./node_modules/marked-repo/test/specs/commonmark"),
-    resolve("./node_modules/marked-repo/test/specs/gfm"),
-    resolve("./node_modules/marked-repo/test/specs/new"),
-    resolve("./node_modules/marked-repo/test/specs/original"),
-    resolve("./node_modules/marked-repo/test/specs/redos"),
-  ]);
-
-  return {
-    CommonMark: tests[0],
-    GFM: tests[1],
-    New: tests[2],
-    Original: tests[3],
-    ReDOS: tests[4],
-  };
-}

package/src/helpers.js

@@ -1,8 +0,0 @@
-import { resolve, dirname } from "node:path";
-import { fileURLToPath } from "node:url";
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-
-export function resolvePath(p) {
-  return resolve(__dirname, p);
-}

package/src/html-differ.js

@@ -1,67 +0,0 @@
-import { HtmlDiffer } from "@markedjs/html-differ";
-
-const htmlDiffer = new HtmlDiffer({
-  ignoreSelfClosingSlash: true,
-  ignoreComments: false,
-});
-
-/**
- * Check if html will display the same
- * @param {string} actual The actual HTML
- * @param {string} expected The expected HTML
- * @returns {boolean} HTML is the same
- */
-export function htmlIsEqual(actual, expected) {
-  return htmlDiffer.isEqual(actual, expected);
-}
-
-/**
- * Get the first difference between actual and expected HTML
- * @param {string} actual The actual HTML
- * @param {string} expected The expected HTML
- * @param {number} padding The number of characters to show around the first difference
- * @returns {{
- *   actual: string,
- *   expected: string,
- * }} An object with the characters around the index of the first difference in the expected and actual strings
- */
-export async function firstDiff(actual, expected, padding) {
-  padding = padding || 30;
-  const diffHtml = await htmlDiffer.diffHtml(actual, expected);
-  const result = diffHtml.reduce(
-    (obj, diff) => {
-      if (diff.added) {
-        if (obj.firstIndex === null) {
-          obj.firstIndex = obj.expected.length;
-        }
-        obj.expected += diff.value;
-      } else if (diff.removed) {
-        if (obj.firstIndex === null) {
-          obj.firstIndex = obj.actual.length;
-        }
-        obj.actual += diff.value;
-      } else {
-        obj.actual += diff.value;
-        obj.expected += diff.value;
-      }
-
-      return obj;
-    },
-    {
-      firstIndex: null,
-      actual: "",
-      expected: "",
-    },
-  );
-
-  return {
-    actual: result.actual.substring(
-      result.firstIndex - padding,
-      result.firstIndex + padding,
-    ),
-    expected: result.expected.substring(
-      result.firstIndex - padding,
-      result.firstIndex + padding,
-    ),
-  };
-}

package/src/index.js

@@ -1,4 +0,0 @@
-export * from "./get-tests.js";
-export * from "./html-differ.js";
-export * from "./output-table.js";
-export * from "./run-tests.js";

package/src/load-tests.js

@@ -1,81 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-import fm from "front-matter";
-import { createRequire } from "node:module";
-
-const require = createRequire(import.meta.url);
-
-export async function loadTests(fileOrDir) {
-  const isFile = fs.statSync(fileOrDir).isFile();
-  const files = isFile ? [path.basename(fileOrDir)] : fs.readdirSync(fileOrDir);
-  const dir = isFile ? path.dirname(fileOrDir) : fileOrDir;
-
-  const obj = {};
-
-  for (const file of files) {
-    const ext = path.extname(file);
-    const name = path.basename(file, ext);
-    const absFile = path.join(dir, file);
-    let specs = [];
-
-    switch (ext) {
-      case ".md": {
-        const content = fm(fs.readFileSync(absFile, "utf8"));
-        const skip = content.attributes.skip;
-        delete content.attributes.skip;
-        const only = content.attributes.only;
-        delete content.attributes.only;
-        specs.push({
-          section: name,
-          markdown: content.body,
-          html: fs.readFileSync(absFile.replace(/[^.]+$/, "html"), "utf8"),
-          options: content.attributes,
-          only,
-          skip,
-        });
-        break;
-      }
-      case ".js":
-      case ".mjs":
-      case ".cjs":
-      case ".json": {
-        let json;
-        try {
-          // try require first
-          json = await require(absFile);
-        } catch (err) {
-          if (err.code !== "ERR_REQUIRE_ESM") {
-            throw err;
-          }
-          // must import esm
-          json = await import(absFile);
-        }
-        specs = specs.concat(json);
-        break;
-      }
-      default:
-      // do nothing
-    }
-
-    for (let i = 0; i < specs.length; i++) {
-      const spec = specs[i];
-      if (!spec.section) {
-        spec.section = `${name}[${i}]`;
-      }
-
-      if (!obj[spec.section]) {
-        obj[spec.section] = {
-          total: 0,
-          pass: 0,
-          specs: [],
-        };
-      }
-
-      obj[spec.section].total++;
-      obj[spec.section].pass += spec.shouldFail ? 0 : 1;
-      obj[spec.section].specs.push(spec);
-    }
-  }
-
-  return obj;
-}

package/src/output-table.js

@@ -1,39 +0,0 @@
-/**
- * Display a table in stdout that lists the sections and what percentage of the tests are not marked shouldFail
- * @param {string} title The title to display above the table
- * @param {Tests} tests The tests to display a table for
- */
-export function outputCompletionTable(title, tests) {
-  let longestName = 0;
-  let maxTests = 0;
-
-  for (const section in tests) {
-    longestName = Math.max(section.length, longestName);
-    maxTests = Math.max(tests[section].total, maxTests);
-  }
-
-  const maxTestsLen = ("" + maxTests).length;
-  const spaces = maxTestsLen * 2 + longestName + 11;
-
-  console.log("-".padEnd(spaces + 4, "-"));
-  console.log(
-    `| ${title
-      .padStart(Math.ceil((spaces + title.length) / 2))
-      .padEnd(spaces)} |`,
-  );
-  console.log(`| ${" ".padEnd(spaces)} |`);
-  for (const section in tests) {
-    console.log(
-      `| ${section.padEnd(longestName)} ${("" + tests[section].pass).padStart(
-        maxTestsLen,
-      )} of ${("" + tests[section].total).padStart(maxTestsLen)} ${(
-        (100 * tests[section].pass) /
-        tests[section].total
-      )
-        .toFixed()
-        .padStart(4)}% |`,
-    );
-  }
-  console.log("-".padEnd(spaces + 4, "-"));
-  console.log();
-}

package/src/run-tests.js

@@ -1,142 +0,0 @@
-import { htmlIsEqual, firstDiff } from "./html-differ.js";
-import { getTests, getAllMarkedSpecTests } from "./get-tests.js";
-import nodeTest from "node:test";
-import assert from "node:assert";
-import { Marked } from "marked";
-import { outputCompletionTable } from "./output-table.js";
-
-/**
- * Run spec tests
- * @param {{
- *   tests: Tests
- *   defaultMarkedOptions: MarkedOptions,
- *   parse: (marked: Marked, options: MarkedOptions, addExtension: (marked: Marked) => void) => string,
- *   addExtension: (marked: Marked) => void,
- *   isEqual: (actual: string, expected: string) => boolean,
- *   diff: (actual: string, expected: string, padding: number) => {firstDiff: number, actual: string, expected: string},
- * }} options
- */
-export async function runTests({
-  tests = {},
-  defaultMarkedOptions = {},
-  parse = parseMarked,
-  addExtension = () => {},
-  isEqual = htmlIsEqual,
-  diff = firstDiff,
-} = {}) {
-  if (typeof tests === "string") {
-    tests = getTests(tests);
-  }
-
-  for (const section of Object.keys(tests)) {
-    const hasOnly = tests[section].specs.some((test) => test.only);
-    await nodeTest(section, { only: hasOnly }, async (t) => {
-      for (const test of tests[section].specs) {
-        const options = {
-          ...defaultMarkedOptions,
-          ...(test.options || {}),
-        };
-        const example = test.example ? " example " + test.example : "";
-        const passFail = test.shouldFail ? "fail" : "pass";
-
-        if (typeof options.silent === "undefined") {
-          options.silent = true;
-        }
-
-        await t.test(
-          `${section} should ${passFail}${example}`,
-          {
-            only: test.only,
-            skip: test.skip,
-          },
-          async () => {
-            const before = process.hrtime();
-            let parsed = parse(test.markdown, options, addExtension);
-            if (options.async) {
-              parsed = await parsed;
-            }
-            const elapsed = process.hrtime(before);
-            const pass = await isEqual(parsed, test.html);
-            if (test.shouldFail) {
-              assert.ok(
-                !pass,
-                `${test.markdown}\n------\n\nExpected: Should Fail`,
-              );
-            } else if (options.renderExact) {
-              assert.strictEqual(test.html, parsed);
-            } else {
-              const testDiff = await diff(parsed, test.html);
-              assert.ok(
-                pass,
-                `Expected: ${testDiff.expected}\n  Actual: ${testDiff.actual}`,
-              );
-            }
-
-            if (!options.async && elapsed[0] > 0) {
-              const s = (elapsed[0] + elapsed[1] * 1e-9).toFixed(3);
-              assert.fail(`took too long: ${s}s`);
-            }
-          },
-        );
-      }
-    });
-  }
-}
-
-/**
- * Run all marked specs with an added extension and optionally output completion table
- * @param {{
- *   addExtension: (marked: Marked) => void,
- *   outputCompletionTable: boolean,
- * }} options
- */
-export async function runAllMarkedSpecTests({
-  addExtension = () => {},
-  outputCompletionTables = true,
-} = {}) {
-  const specTests = await getAllMarkedSpecTests();
-
-  await Promise.all(
-    Object.keys(specTests).map((title) => {
-      const tests = specTests[title];
-      switch (title) {
-        case "CommonMark":
-          if (outputCompletionTables) {
-            outputCompletionTable(title, tests);
-          }
-          return runTests({
-            tests,
-            defaultMarkedOptions: { gfm: false, pedantic: false },
-            addExtension,
-          });
-        case "GFM":
-          if (outputCompletionTables) {
-            outputCompletionTable(title, tests);
-          }
-          return runTests({
-            tests,
-            defaultMarkedOptions: { gfm: true, pedantic: false },
-            addExtension,
-          });
-        case "New":
-          return runTests({ tests, addExtension });
-        case "Original":
-          return runTests({
-            tests,
-            defaultMarkedOptions: { gfm: false, pedantic: true },
-            addExtension,
-          });
-        case "ReDOS":
-          return runTests({ tests, addExtension });
-        default:
-          throw new Error("invalid title");
-      }
-    }),
-  );
-}
-
-function parseMarked(markedown, options, addExtension) {
-  const marked = new Marked(options);
-  addExtension(marked);
-  return marked.parse(markedown);
-}

package/test/get-tests.test.js

@@ -1,22 +0,0 @@
-import { getTests } from "../src/index.js";
-import { resolvePath } from "../src/helpers.js";
-import test from "node:test";
-import assert from "node:assert";
-
-test("get-tests", async (t) => {
-  await t.test("getTests(string)", async () => {
-    const tests = await getTests(
-      resolvePath("../node_modules/marked-repo/test/specs/commonmark"),
-    );
-
-    assert.ok(tests.Tabs);
-  });
-
-  await t.test("getTests(array)", async () => {
-    const tests = await getTests([
-      resolvePath("../node_modules/marked-repo/test/specs/commonmark"),
-    ]);
-
-    assert.ok(tests[0].Tabs);
-  });
-});

package/test/html-differ.test.js

@@ -1,31 +0,0 @@
-import { htmlIsEqual, firstDiff } from "../src/index.js";
-import test from "node:test";
-import assert from "node:assert";
-
-test("html-differ", async (t) => {
-  await t.test("htmlIsEqual is equal", async () => {
-    const same = await htmlIsEqual("<p> test </p>", "<p>  test  </p>");
-
-    assert.ok(same);
-  });
-
-  await t.test("htmlIsEqual is not equal", async () => {
-    const same = await htmlIsEqual("<p>test1</p>", "<p>test2</p>");
-
-    assert.ok(!same);
-  });
-
-  await t.test("firstDiff", async () => {
-    const diff = await firstDiff("<p>test1</p>", "<p>test2</p>");
-
-    assert.strictEqual(diff.actual, "<p>test1</p>");
-    assert.strictEqual(diff.expected, "<p>test2</p>");
-  });
-
-  await t.test("firstDiff padding", async () => {
-    const diff = await firstDiff("<p>test1</p>", "<p>test2</p>", 5);
-
-    assert.strictEqual(diff.actual, "<p>test1");
-    assert.strictEqual(diff.expected, "<p>test2");
-  });
-});

package/test/output-table.test.js

@@ -1,24 +0,0 @@
-import { outputCompletionTable } from "../src/index.js";
-import test from "node:test";
-import assert from "node:assert";
-
-test("output-table", (t) => {
-  t.test("outputCompletionTable", () => {
-    let output = "";
-    t.mock.method(console, "log", (...args) => {
-      output += args.join(" ") + "\n";
-    });
-    const tests = {
-      Tests: {
-        total: 1,
-        pass: 1,
-      },
-    };
-    outputCompletionTable("Title", tests);
-
-    assert.strictEqual(
-      output,
-      "----------------------\n|        Title       |\n|                    |\n| Tests 1 of 1  100% |\n----------------------\n\n",
-    );
-  });
-});

package/test/run-tests.test.js

@@ -1,8 +0,0 @@
-import { runAllMarkedSpecTests } from "../src/index.js";
-import test from "node:test";
-
-test("run-tests", async (t) => {
-  await t.test("runAllMarkedSpecTests", async () => {
-    await runAllMarkedSpecTests();
-  });
-});

package/types/index.d.ts

@@ -1,18 +0,0 @@
-import type { MarkedOptions } from "marked";
-
-export interface Spec {
-  section?: string;
-  markdown: string;
-  html: string;
-  example?: number;
-  options?: MarkedOptions;
-  only?: boolean;
-  skip?: boolean;
-  shouldFail?: boolean;
-}
-
-export interface Tests {
-  total: number;
-  pass: number;
-  specs: Spec[];
-}