Simplify runtime type error messages.

Author: jaydenseric

analyseCoverage.mjs

@@ -15,7 +15,7 @@ import sourceRange from "./sourceRange.mjs";
  */
 export default async function analyseCoverage(coverageDirPath) {
   if (typeof coverageDirPath !== "string")
-    throw new TypeError("First argument `coverageDirPath` must be a string.");
+    throw new TypeError("Argument 1 `coverageDirPath` must be a string.");
 
   const coverageDirFileNames = await fs.promises.readdir(coverageDirPath);
   const filteredProcessCoverages = [];

analyseCoverage.test.mjs

@@ -14,14 +14,14 @@ import childProcessPromise from "./childProcessPromise.mjs";
  */
 export default (tests) => {
   tests.add(
-    "`reportCliError` with first argument `coverageDirPath` not a string.",
+    "`reportCliError` with argument 1 `coverageDirPath` not a string.",
     async () => {
       await rejects(
         analyseCoverage(
           // @ts-expect-error Testing invalid.
           true
         ),
-        new TypeError("First argument `coverageDirPath` must be a string.")
+        new TypeError("Argument 1 `coverageDirPath` must be a string.")
       );
     }
   );

changelog.md

@@ -23,6 +23,7 @@
 - Renamed imports in the test index module.
 - Added `CliError` class tests.
 - Runtime type check `CLiError` constructor arguments.
+- Simplified runtime type error messages.
 - Readme tweaks.
 
 ## 5.0.1

childProcessPromise.mjs

@@ -14,7 +14,7 @@ import { ChildProcess } from "child_process";
 export default async function childProcessPromise(childProcess) {
   if (!(childProcess instanceof ChildProcess))
     throw new TypeError(
-      "First argument `childProcess` must be a `ChildProcess` instance."
+      "Argument 1 `childProcess` must be a `ChildProcess` instance."
     );
 
   return new Promise((resolve, reject) => {

childProcessPromise.test.mjs

@@ -9,15 +9,15 @@ import childProcessPromise from "./childProcessPromise.mjs";
  */
 export default (tests) => {
   tests.add(
-    "`childProcessPromise` with first argument `childProcess` not a `ChildProcess` instance.",
+    "`childProcessPromise` with argument 1 `childProcess` not a `ChildProcess` instance.",
     async () => {
       await rejects(
         childProcessPromise(
           // @ts-expect-error Testing invalid.
           true
         ),
         new TypeError(
-          "First argument `childProcess` must be a `ChildProcess` instance."
+          "Argument 1 `childProcess` must be a `ChildProcess` instance."
         )
       );
     }

reportCliError.mjs

@@ -12,7 +12,7 @@ import errorConsole from "./errorConsole.mjs";
  */
 export default function reportCliError(cliDescription, error) {
   if (typeof cliDescription !== "string")
-    throw new TypeError("First argument `cliDescription` must be a string.");
+    throw new TypeError("Argument 1 `cliDescription` must be a string.");
 
   errorConsole.group(
     // Whitespace blank lines shouldn’t have redundant indentation or color.

reportCliError.test.mjs

@@ -20,15 +20,15 @@ const REPORT_CLI_ERROR_PATH = fileURLToPath(
  */
 export default (tests) => {
   tests.add(
-    "`reportCliError` with first argument `cliDescription` not a string.",
+    "`reportCliError` with argument 1 `cliDescription` not a string.",
     () => {
       throws(() => {
         reportCliError(
           // @ts-expect-error Testing invalid.
           true,
           new Error("Message.")
         );
-      }, new TypeError("First argument `cliDescription` must be a string."));
+      }, new TypeError("Argument 1 `cliDescription` must be a string."));
     }
   );
 

semver.mjs

@@ -8,7 +8,7 @@
  */
 export default function semver(semver) {
   if (typeof semver !== "string")
-    throw new TypeError("First argument `semver` must be a string.");
+    throw new TypeError("Argument 1 `semver` must be a string.");
 
   const match = semver.match(
     // The is is official recommended RegEx, see:
@@ -17,7 +17,7 @@ export default function semver(semver) {
   );
 
   if (!match)
-    throw new TypeError("First argument `semver` must be a semver string.");
+    throw new TypeError("Argument 1 `semver` must be a semver string.");
 
   const [, major, minor, patch, prerelease, build] = match;
 

semver.test.mjs

@@ -8,23 +8,20 @@ import semver from "./semver.mjs";
  * @param {import("test-director").default} tests Test director.
  */
 export default (tests) => {
-  tests.add("`semver` with first argument `semver` not a string.", () => {
+  tests.add("`semver` with argument 1 `semver` not a string.", () => {
     throws(() => {
       semver(
         // @ts-expect-error Testing invalid.
         true
       );
-    }, new TypeError("First argument `semver` must be a string."));
+    }, new TypeError("Argument 1 `semver` must be a string."));
   });
 
-  tests.add(
-    "`semver` with first argument `semver` not a semver string.",
-    () => {
-      throws(() => {
-        semver("");
-      }, new TypeError("First argument `semver` must be a semver string."));
-    }
-  );
+  tests.add("`semver` with argument 1 `semver` not a semver string.", () => {
+    throws(() => {
+      semver("");
+    }, new TypeError("Argument 1 `semver` must be a semver string."));
+  });
 
   tests.add("`semver` with a simple version.", () => {
     deepStrictEqual(semver("1.2.3"), {

sourceRange.mjs

@@ -19,20 +19,20 @@ export default function sourceRange(
   ignoreNextLineComment = " coverage ignore next line"
 ) {
   if (typeof source !== "string")
-    throw new TypeError("First argument `source` must be a string.");
+    throw new TypeError("Argument 1 `source` must be a string.");
 
   if (typeof startOffset !== "number")
-    throw new TypeError("Second argument `startOffset` must be a number.");
+    throw new TypeError("Argument 2 `startOffset` must be a number.");
 
   if (typeof endOffset !== "number")
-    throw new TypeError("Third argument `endOffset` must be a number.");
+    throw new TypeError("Argument 3 `endOffset` must be a number.");
 
   if (
     typeof ignoreNextLineComment !== "string" &&
     ignoreNextLineComment !== false
   )
     throw new TypeError(
-      "Fourth argument `ignoreNextLineComment` must be a string or `false`."
+      "Argument 4 `ignoreNextLineComment` must be a string or `false`."
     );
 
   const ignoreNextLineCommentLowerCase = ignoreNextLineComment

sourceRange.test.mjs

@@ -8,47 +8,41 @@ import sourceRange from "./sourceRange.mjs";
  * @param {import("test-director").default} tests Test director.
  */
 export default (tests) => {
-  tests.add("`sourceRange` with first argument `source` not a string.", () => {
+  tests.add("`sourceRange` with argument 1 `source` not a string.", () => {
     throws(() => {
       sourceRange(
         // @ts-expect-error Testing invalid.
         true,
         0,
         0
       );
-    }, new TypeError("First argument `source` must be a string."));
+    }, new TypeError("Argument 1 `source` must be a string."));
   });
 
-  tests.add(
-    "`sourceRange` with second argument `startOffset` not a number.",
-    () => {
-      throws(() => {
-        sourceRange(
-          "a",
-          // @ts-expect-error Testing invalid.
-          true,
-          0
-        );
-      }, new TypeError("Second argument `startOffset` must be a number."));
-    }
-  );
+  tests.add("`sourceRange` with argument 2 `startOffset` not a number.", () => {
+    throws(() => {
+      sourceRange(
+        "a",
+        // @ts-expect-error Testing invalid.
+        true,
+        0
+      );
+    }, new TypeError("Argument 2 `startOffset` must be a number."));
+  });
 
-  tests.add(
-    "`sourceRange` with third argument `endOffset` not a number.",
-    () => {
-      throws(() => {
-        sourceRange(
-          "a",
-          0,
-          // @ts-expect-error Testing invalid.
-          true
-        );
-      }, new TypeError("Third argument `endOffset` must be a number."));
-    }
-  );
+  tests.add("`sourceRange` with argument 3 `endOffset` not a number.", () => {
+    throws(() => {
+      sourceRange(
+        "a",
+        0,
+        // @ts-expect-error Testing invalid.
+        true
+      );
+    }, new TypeError("Argument 3 `endOffset` must be a number."));
+  });
 
   tests.add(
-    "`sourceRange` with fourth argument `ignoreNextLineComment` not a string or `false`.",
+    "`sourceRange` with argument 4 `ignoreNextLineComment` not a string or `false`.",
     () => {
       throws(() => {
         sourceRange(
@@ -58,7 +52,7 @@ export default (tests) => {
           // @ts-expect-error Testing invalid.
           true
         );
-      }, new TypeError("Fourth argument `ignoreNextLineComment` must be a string or `false`."));
+      }, new TypeError("Argument 4 `ignoreNextLineComment` must be a string or `false`."));
     }
   );
 

test/replaceStackTraces.mjs

@@ -13,10 +13,10 @@ export default function replaceStackTraces(
   replacer = "$1<stack trace>"
 ) {
   if (typeof string !== "string")
-    throw new TypeError("First argument `string` must be a string.");
+    throw new TypeError("Argument 1 `string` must be a string.");
 
   if (typeof replacer !== "string")
-    throw new TypeError("Second argument `replacer` must be a string.");
+    throw new TypeError("Argument 2 `replacer` must be a string.");
 
   return string.replace(
     /(^ {2,})at (?:(?! \{$).)+(?:\r?\n\1at (?:(?! \{$).)+)*/gmu,

test/replaceStackTraces.test.mjs

@@ -9,27 +9,27 @@ import replaceStackTraces from "./replaceStackTraces.mjs";
  */
 export default (tests) => {
   tests.add(
-    "`replaceStackTraces` with first argument `string` not a string.",
+    "`replaceStackTraces` with argument 1 `string` not a string.",
     () => {
       throws(() => {
         replaceStackTraces(
           // @ts-expect-error Testing invalid.
           true
         );
-      }, new TypeError("First argument `string` must be a string."));
+      }, new TypeError("Argument 1 `string` must be a string."));
     }
   );
 
   tests.add(
-    "`replaceStackTraces` with second argument `replacer` not a string.",
+    "`replaceStackTraces` with argument 2 `replacer` not a string.",
     () => {
       throws(() => {
         replaceStackTraces(
           "",
           // @ts-expect-error Testing invalid.
           true
         );
-      }, new TypeError("Second argument `replacer` must be a string."));
+      }, new TypeError("Argument 2 `replacer` must be a string."));
     }
   );