fix: only strip a whole index segment in routePathFromFile

.changeset/index-suffix-segment.md

@@ -0,0 +1,5 @@
+---
+"filesystem-routing": patch
+---
+
+Only strip a whole `index` segment when mapping route files to paths. Route files whose names merely end in "index", such as `routes/reindex.tsx`, were previously mapped to `/re` instead of `/reindex`.

src/convention.ts

@@ -14,7 +14,8 @@ export function routePathFromFile(routeFile: string): string {
   const routePath = routeFile
     // remove the initial slash
     .slice(1)
-    .replace(/index$/, "")
+    // only strip a whole `index` segment, not a name that merely ends in "index" (e.g. `reindex`)
+    .replace(/(^|\/)index$/, "$1")
     .replace(/\[([^/]+)\]/g, (_, m) => {
       if (m.length > 3 && m.startsWith("...")) {
         return `*${m.slice(3)}`;

test/convention.spec.ts

@@ -28,6 +28,16 @@ describe("routePathFromFile", () => {
   it("retains group segments for emission adapters", () => {
     expect(routePathFromFile("/(marketing)/about")).toBe("/(marketing)/about");
   });
+
+  // https://github.com/solidjs/solid-start/issues/2314
+  it("only strips index as a whole segment, not as a filename suffix", () => {
+    expect(routePathFromFile("/reindex")).toBe("/reindex");
+    expect(routePathFromFile("/myindex")).toBe("/myindex");
+    expect(routePathFromFile("/appendix")).toBe("/appendix");
+    expect(routePathFromFile("/blog/reindex")).toBe("/blog/reindex");
+    expect(routePathFromFile("/reindex/index")).toBe("/reindex/");
+    expect(routePathFromFile("/[id]/index")).toBe("/:id/");
+  });
 });
 
 const temporaryDirectories: string[] = [];
@@ -75,6 +85,19 @@ describe("PageFileSystemRouter", () => {
     expect(post.$$route?.pick).toEqual(["route"]);
   });
 
+  it("keeps route files whose names end in index at their own path", async () => {
+    const dir = createRouteTree({
+      "reindex.tsx": "export default () => <h1>Reindex</h1>;",
+      "blog/index.tsx": "export default () => <h1>Blog</h1>;",
+      "blog/myindex.tsx": "export default () => <h1>My index</h1>;"
+    });
+    const router = new PageFileSystemRouter({ dir, extensions: ["tsx"] });
+
+    const paths = (await router.getRoutes()).map(route => route.path).sort();
+
+    expect(paths).toEqual(["/blog/", "/blog/myindex", "/reindex"]);
+  });
+
   it("resolves a relative dir against the current working directory", async () => {
     const dir = createRouteTree({
       "index.tsx": "export default () => <h1>Home</h1>;",