Improved error messages and stack size (#363)

blakeembrey · web-flow · commit a6bdf4045f36 · 2025-08-18T11:02:22.000-07:00
diff --git a/package.json b/package.json
@@ -53,7 +53,7 @@
   "size-limit": [
     {
       "path": "dist/index.js",
-      "limit": "2.2 kB"
+      "limit": "2 kB"
     }
   ],
   "ts-scripts": {
diff --git a/src/cases.spec.ts b/src/cases.spec.ts
@@ -6,6 +6,7 @@ import {
   type CompileOptions,
   type ParamData,
   TokenData,
+  Path,
 } from "./index.js";
 
 export interface ParserTestSet {
@@ -21,7 +22,7 @@ export interface StringifyTestSet {
 }
 
 export interface CompileTestSet {
-  path: string;
+  path: Path;
   options?: CompileOptions & ParseOptions;
   tests: Array<{
     input: ParamData | undefined;
@@ -30,7 +31,7 @@ export interface CompileTestSet {
 }
 
 export interface MatchTestSet {
-  path: string;
+  path: Path | Path[];
   options?: MatchOptions & ParseOptions;
   tests: Array<{
     input: string;
@@ -41,64 +42,99 @@ export interface MatchTestSet {
 export const PARSER_TESTS: ParserTestSet[] = [
   {
     path: "/",
-    expected: new TokenData([{ type: "text", value: "/" }]),
+    expected: new TokenData([{ type: "text", value: "/" }], "/"),
   },
   {
     path: "/:test",
-    expected: new TokenData([
-      { type: "text", value: "/" },
-      { type: "param", name: "test" },
-    ]),
+    expected: new TokenData(
+      [
+        { type: "text", value: "/" },
+        { type: "param", name: "test" },
+      ],
+      "/:test",
+    ),
+  },
+  {
+    path: "/:a:b",
+    expected: new TokenData(
+      [
+        { type: "text", value: "/" },
+        { type: "param", name: "a" },
+        { type: "param", name: "b" },
+      ],
+      "/:a:b",
+    ),
   },
   {
     path: '/:"0"',
-    expected: new TokenData([
-      { type: "text", value: "/" },
-      { type: "param", name: "0" },
-    ]),
+    expected: new TokenData(
+      [
+        { type: "text", value: "/" },
+        { type: "param", name: "0" },
+      ],
+      '/:"0"',
+    ),
   },
   {
     path: "/:_",
-    expected: new TokenData([
-      { type: "text", value: "/" },
-      { type: "param", name: "_" },
-    ]),
+    expected: new TokenData(
+      [
+        { type: "text", value: "/" },
+        { type: "param", name: "_" },
+      ],
+      "/:_",
+    ),
   },
   {
     path: "/:café",
-    expected: new TokenData([
-      { type: "text", value: "/" },
-      { type: "param", name: "café" },
-    ]),
+    expected: new TokenData(
+      [
+        { type: "text", value: "/" },
+        { type: "param", name: "café" },
+      ],
+      "/:café",
+    ),
   },
   {
     path: '/:"123"',
-    expected: new TokenData([
-      { type: "text", value: "/" },
-      { type: "param", name: "123" },
-    ]),
+    expected: new TokenData(
+      [
+        { type: "text", value: "/" },
+        { type: "param", name: "123" },
+      ],
+      '/:"123"',
+    ),
   },
   {
     path: '/:"1\\"\\2\\"3"',
-    expected: new TokenData([
-      { type: "text", value: "/" },
-      { type: "param", name: '1"2"3' },
-    ]),
+    expected: new TokenData(
+      [
+        { type: "text", value: "/" },
+        { type: "param", name: '1"2"3' },
+      ],
+      '/:"1\\"\\2\\"3"',
+    ),
   },
   {
     path: "/*path",
-    expected: new TokenData([
-      { type: "text", value: "/" },
-      { type: "wildcard", name: "path" },
-    ]),
+    expected: new TokenData(
+      [
+        { type: "text", value: "/" },
+        { type: "wildcard", name: "path" },
+      ],
+      "/*path",
+    ),
   },
   {
     path: '/:"test"stuff',
-    expected: new TokenData([
-      { type: "text", value: "/" },
-      { type: "param", name: "test" },
-      { type: "text", value: "stuff" },
-    ]),
+    expected: new TokenData(
+      [
+        { type: "text", value: "/" },
+        { type: "param", name: "test" },
+        { type: "text", value: "stuff" },
+      ],
+      '/:"test"stuff',
+    ),
   },
 ];
 
@@ -1609,4 +1645,20 @@ export const MATCH_TESTS: MatchTestSet[] = [
       },
     ],
   },
+
+  /**
+   * Array input is normalized.
+   */
+  {
+    path: ["/:foo/:bar", "/:foo/:baz"],
+    tests: [
+      {
+        input: "/hello/world",
+        expected: {
+          path: "/hello/world",
+          params: { foo: "hello", bar: "world" },
+        },
+      },
+    ],
+  },
 ];
diff --git a/src/index.spec.ts b/src/index.spec.ts
@@ -1,5 +1,12 @@
 import { describe, it, expect } from "vitest";
-import { parse, compile, match, stringify } from "./index.js";
+import {
+  parse,
+  compile,
+  match,
+  stringify,
+  pathToRegexp,
+  TokenData,
+} from "./index.js";
 import {
   PARSER_TESTS,
   COMPILE_TESTS,
@@ -15,38 +22,39 @@ describe("path-to-regexp", () => {
     it("should throw on unbalanced group", () => {
       expect(() => parse("/{:foo,")).toThrow(
         new TypeError(
-          "Unexpected END at 7, expected }: https://git.new/pathToRegexpError",
+          "Unexpected END at index 7, expected }: /{:foo,; visit https://git.new/pathToRegexpError for info",
         ),
       );
     });
+
     it("should throw on nested unbalanced group", () => {
       expect(() => parse("/{:foo/{x,y}")).toThrow(
         new TypeError(
-          "Unexpected END at 12, expected }: https://git.new/pathToRegexpError",
+          "Unexpected END at index 12, expected }: /{:foo/{x,y}; visit https://git.new/pathToRegexpError for info",
         ),
       );
     });
 
     it("should throw on missing param name", () => {
       expect(() => parse("/:/")).toThrow(
         new TypeError(
-          "Missing parameter name at 2: https://git.new/pathToRegexpError",
+          "Missing parameter name at index 2: /:/; visit https://git.new/pathToRegexpError for info",
         ),
       );
     });
 
     it("should throw on missing wildcard name", () => {
       expect(() => parse("/*/")).toThrow(
         new TypeError(
-          "Missing parameter name at 2: https://git.new/pathToRegexpError",
+          "Missing parameter name at index 2: /*/; visit https://git.new/pathToRegexpError for info",
         ),
       );
     });
 
     it("should throw on unterminated quote", () => {
       expect(() => parse('/:"foo')).toThrow(
         new TypeError(
-          "Unterminated quote at 2: https://git.new/pathToRegexpError",
+          'Unterminated quote at index 2: /:"foo; visit https://git.new/pathToRegexpError for info',
         ),
       );
     });
@@ -94,6 +102,63 @@ describe("path-to-regexp", () => {
     });
   });
 
+  describe("pathToRegexp errors", () => {
+    it("should throw when missing text between params", () => {
+      expect(() => pathToRegexp("/:foo:bar")).toThrow(
+        new TypeError(
+          'Missing text before "bar": /:foo:bar; visit https://git.new/pathToRegexpError for info',
+        ),
+      );
+    });
+
+    it("should throw when missing text between params using TokenData", () => {
+      expect(() =>
+        pathToRegexp(
+          new TokenData([
+            { type: "param", name: "a" },
+            { type: "param", name: "b" },
+          ]),
+        ),
+      ).toThrow(
+        new TypeError(
+          'Missing text before "b"; visit https://git.new/pathToRegexpError for info',
+        ),
+      );
+    });
+
+    it("should throw with `originalPath` when missing text between params using TokenData", () => {
+      expect(() =>
+        pathToRegexp(
+          new TokenData(
+            [
+              { type: "param", name: "a" },
+              { type: "param", name: "b" },
+            ],
+            "/[a][b]",
+          ),
+        ),
+      ).toThrow(
+        new TypeError(
+          'Missing text before "b": /[a][b]; visit https://git.new/pathToRegexpError for info',
+        ),
+      );
+    });
+
+    it("should contain the error line", () => {
+      expect.hasAssertions();
+
+      try {
+        pathToRegexp("/:");
+      } catch (error) {
+        const stack = (error as Error).stack
+          ?.split("\n")
+          .slice(0, 5)
+          .join("\n");
+        expect(stack).toContain("index.spec.ts");
+      }
+    });
+  });
+
   describe.each(PARSER_TESTS)(
     "parse $path with $options",
     ({ path, options, expected }) => {
diff --git a/src/index.ts b/src/index.ts

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@`
`53`	`53`	`"size-limit": [`
`54`	`54`	`{`
`55`	`55`	`"path": "dist/index.js",`
`56`		`- "limit": "2.2 kB"`
	`56`	`+ "limit": "2 kB"`
`57`	`57`	`}`
`58`	`58`	`],`
`59`	`59`	`"ts-scripts": {`