fix typegen when same route is reused in multiple paths (#13574)

Author: pcattori

.changeset/gold-baboons-roll.md

@@ -0,0 +1,23 @@
+---
+"@react-router/dev": patch
+"react-router": patch
+---
+
+Fix typegen when same route is used at multiple paths
+
+For example, `routes/route.tsx` is used at 4 different paths here:
+
+```ts
+import { type RouteConfig, route } from "@react-router/dev/routes";
+export default [
+  route("base/:base", "routes/base.tsx", [
+    route("home/:home", "routes/route.tsx", { id: "home" }),
+    route("changelog/:changelog", "routes/route.tsx", { id: "changelog" }),
+    route("splat/*", "routes/route.tsx", { id: "splat" }),
+  ]),
+  route("other/:other", "routes/route.tsx", { id: "other" }),
+] satisfies RouteConfig;
+```
+
+Previously, typegen would arbitrarily pick one of these paths to be the "winner" and generate types for the route module based on that path.
+Now, typegen creates unions as necessary for alternate paths for the same route file.

integration/typegen-test.ts

@@ -610,4 +610,86 @@ test.describe("typegen", () => {
       expect(proc.status).toBe(0);
     });
   });
+
+  test("reuse route file at multiple paths", async () => {
+    const cwd = await createProject({
+      "vite.config.ts": viteConfig,
+      "app/expect-type.ts": expectType,
+      "app/routes.ts": tsx`
+        import { type RouteConfig, route } from "@react-router/dev/routes";
+        export default [
+          route("base/:base", "routes/base.tsx", [
+            route("home/:home", "routes/route.tsx", { id: "home" }),
+            route("changelog/:changelog", "routes/route.tsx", { id: "changelog" }),
+            route("splat/*", "routes/route.tsx", { id: "splat" }),
+          ]),
+          route("other/:other", "routes/route.tsx", { id: "other" })
+        ] satisfies RouteConfig;
+      `,
+      "app/routes/base.tsx": tsx`
+        import { Outlet } from "react-router"
+        import type { Route } from "./+types/base"
+
+        export function loader() {
+          return { base: "hello" }
+        }
+
+        export default function Component() {
+          return (
+            <>
+              <h1>Layout</h1>
+              <Outlet/>
+            </>
+          )
+        }
+      `,
+      "app/routes/route.tsx": tsx`
+        import type { Expect, Equal } from "../expect-type"
+        import type { Route } from "./+types/route"
+
+        export function loader() {
+          return { route: "world" }
+        }
+
+        export default function Component({ params, matches }: Route.ComponentProps) {
+          type Test = Expect<Equal<typeof params,
+            | {
+                  base: string;
+                  home: string;
+                  changelog?: undefined;
+                  "*"?: undefined;
+                  other?: undefined;
+                }
+              | {
+                  base: string;
+                  home?: undefined;
+                  changelog: string;
+                  "*"?: undefined;
+                  other?: undefined;
+                }
+              | {
+                  base: string;
+                  home?: undefined;
+                  changelog?: undefined;
+                  "*": string;
+                  other?: undefined;
+                }
+              | {
+                  base?: undefined;
+                  home?: undefined;
+                  changelog?: undefined;
+                  "*"?: undefined;
+                  other: string;
+                }
+          >>
+          return <h1>Hello, world!</h1>
+        }
+      `,
+    });
+
+    const proc = typecheck(cwd);
+    expect(proc.stdout.toString()).toBe("");
+    expect(proc.stderr.toString()).toBe("");
+    expect(proc.status).toBe(0);
+  });
 });