@markedjs/testutils 9.1.0-1 → 9.1.0-2

package/README.md

@@ -1,6 +1,21 @@
 # @markedjs/testutils
 
-Test utilities for marked and marked extensions
+Test utilities for marked and marked extensions.
+
+## Versioning
+
+This is versioned as the version of marked that it includes tests for with the prerelease version being an integer that gets incremented when we release a new fix or feature without updating the marked version.
+
+We recommend to pin to a single version instead of using a range since any update may contain breaking changes.
+
+**Example**
+
+```json
+// package.json
+"dependencies": {
+  "@markedjs/testutils": "9.1.0-0"
+}
+```
 
 ## API
 
@@ -11,8 +26,8 @@ Get all marked [Tests](#tests)
 ### `getTests(dirs)`
 
 Get [Tests](#tests) from a directory or file.
-`dirs` can be a string, an array of strings, or an object with string values.
-The return type is the same as the input a Tests object, an array of Tests objects, or an object with Tests object values.
+`dirs` can be a string or an array of strings.
+The return type is the same as the input a Tests object or an array of Tests objects.
 
 ### `htmlIsEqual(actual, expected)`
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markedjs/testutils",
-  "version": "9.1.0-1",
+  "version": "9.1.0-2",
   "description": "Test utilities for marked and marked extensions",
   "main": "src/index.js",
   "type": "module",

package/src/get-tests.js

@@ -3,26 +3,15 @@ import { resolvePath } from "./helpers.js";
 
 /**
  * Get tests from a directory or file
- * @param {string | [string] | {key: string}} dirs Can be a string, array of strings, or an object with string values
- * @returns {Tests | [Tests] | {key: Tests}} The return type will match the input, a tests object, array of tests objects, or an object with tests objects values
+ * @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 (typeof dirs === "string") {
-    return await loadTests(dirs);
-  }
-
   if (Array.isArray(dirs)) {
     return await Promise.all(dirs.map((dir) => loadTests(dir)));
   }
 
-  const keys = Object.keys(dirs);
-  const tests = await Promise.all(keys.map((key) => loadTests(dirs[key])));
-  const testsObj = {};
-  for (let i = 0; i < keys.length; i++) {
-    testsObj[keys[i]] = tests[i];
-  }
-
-  return testsObj;
+  return await loadTests(dirs);
 }
 
 /**
@@ -36,13 +25,19 @@ export async function getTests(dirs) {
  * }} All marked spec tests
  */
 export async function getAllMarkedSpecTests() {
-  return await getTests({
-    CommonMark: resolvePath(
-      "../node_modules/marked-repo/test/specs/commonmark",
-    ),
-    GFM: resolvePath("../node_modules/marked-repo/test/specs/gfm"),
-    New: resolvePath("../node_modules/marked-repo/test/specs/new"),
-    Original: resolvePath("../node_modules/marked-repo/test/specs/original"),
-    ReDOS: resolvePath("../node_modules/marked-repo/test/specs/redos"),
-  });
+  const tests = await getTests([
+    resolvePath("../node_modules/marked-repo/test/specs/commonmark"),
+    resolvePath("../node_modules/marked-repo/test/specs/gfm"),
+    resolvePath("../node_modules/marked-repo/test/specs/new"),
+    resolvePath("../node_modules/marked-repo/test/specs/original"),
+    resolvePath("../node_modules/marked-repo/test/specs/redos"),
+  ]);
+
+  return {
+    CommonMark: tests[0],
+    GFM: tests[1],
+    New: tests[2],
+    Original: tests[3],
+    ReDOS: tests[4],
+  };
 }

package/test/get-tests.test.js

@@ -19,12 +19,4 @@ test("get-tests", async (t) => {
 
     assert.ok(tests[0].Tabs);
   });
-
-  await t.test("getTests(obj)", async () => {
-    const tests = await getTests({
-      test: resolvePath("../node_modules/marked-repo/test/specs/commonmark"),
-    });
-
-    assert.ok(tests.test.Tabs);
-  });
 });