How to share param schemas between file routes without breaking react-refresh

[jedwards1211]

I have /users/$userId, /users/$userId/change-email, /users/$userId/change-password etc routes. I want to share the schema for the userId param between all the file routes for these. Here's the code for /users/$userId:

routes/users/$userId/index.tsx

import { createFileRoute } from "@tanstack/react-router";
import { z } from "zod";
import { UserSettingsView } from "../../../../components/UserSettingsView.tsx";
import Container from "@mui/material/Container";
import { IntParamSchema } from "../../../../types/IntParamSchema.ts";

const UserRoute = () => {
  const { userId } = Route.useParams();

  return (
    <Container maxWidth="sm" sx={{ marginY: 4 }}>
      <UserSettingsView userId={userId} />
    </Container>
  );
};

const paramsSchema = z.object({
  userId: IntParamSchema,
});

export const Route = createFileRoute("/_protected/users/$userId/")({
  component: UserRoute,
  params: {
    parse: paramsSchema.parse,
    stringify: (params) => ({ userId: String(params.userId) }),
  },
});

Here's the problem...I want to export the paramsSchema to share it with routes/users/$userId/change-email.tsx etc, but if I do so, I get an ESLint warning that it breaks react-refresh:

My unappealing set of options right now seems to be:

• put the schema in some file completely outside of routes
• move React components from index.tsx route to some other file completely outside routes (would create circular imports ugh, though I guess there probably wouldn't be tdz issues)
• export UserRoute and tack paramsSchema onto it as a property (hacky workaround)
• just accept that fast refresh won't work for index routes like this

At the very least I wish I could export it from a file next to routes/users/$userId/index.tsx with some kind of special name that prevents the codegen tool from treating it as a route.

[schiller-manuel]

look at https://tanstack.com/router/latest/docs/api/file-based-routing#routefileignoreprefix

[jedwards1211]

Oh thanks! That works, I hadn't managed to find it