Skip typegen for routes outside the app directory #12996

wilcoxmd · 2025-02-11T06:49:43Z

This is a fix for #12993.

This PR limits typegen to only occur for route files in the current project's app directory. This behavior should be consistent with the current getTypesPath logic and generated Module typing, which also seem to assume that route files are located in the app directory.

Adding this check prevents type files from being generated outside .react-router/types (which can cause tsc failures) if a route file is located outside the current project's app directory, which is the case for route definitions imported from a library or monorepo workspace package. For now, route library/workspace packages can rely on their own separate typecheck processes to ensure routes are typesafe before they are imported to another application.

In the future it would be nice to figure out a way to include library route typings into a host project's typegen process. However, I imagine this approach would probably require more thought and input from the team to decide on where to generate those files and how they should be consumed. In the meantime, this PR's goal is just to help prevent unintended issues without changing the current typgen behavior too much.

Very open to feedback on this, particularly on the testing approach! I couldn't find a great pattern for testing workspace-style project structures, so I just created a new set of fixtures and a way to tweak their content as part of setting up the test in 74fed50. Let me know if you'd prefer a different strategy!

The primary source code change is in 6902a87

changeset-bot · 2025-02-11T06:49:47Z

🦋 Changeset detected

Latest commit: b577dde

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 11 packages

Name	Type
@react-router/dev	Patch
@react-router/fs-routes	Patch
@react-router/remix-routes-option-adapter	Patch
create-react-router	Patch
react-router	Patch
react-router-dom	Patch
@react-router/architect	Patch
@react-router/cloudflare	Patch
@react-router/express	Patch
@react-router/node	Patch
@react-router/serve	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

remix-cla-bot · 2025-02-11T06:49:49Z

Hi @wilcoxmd,

Welcome, and thank you for contributing to React Router!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at [email protected].

Thanks!

- The Remix team

Adds workspace routes fixture and a failing test

wilcoxmd · 2025-02-11T07:42:27Z

pnpm-workspace.yaml

@@ -1,5 +1,5 @@
 packages:
  - "integration"
-  - "integration/helpers/*"
+  - "integration/helpers/**"


This update allows the workspace fixture to install node modules in nested directories

remix-cla-bot · 2025-02-12T14:07:01Z

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

wilcoxmd · 2025-02-12T16:42:12Z

packages/react-router-dev/typegen/index.ts

@@ -71,11 +72,21 @@ async function createContext({
  };
 }

+function isRouteInAppDirectory(ctx: Context, route: RouteManifestEntry) {
+  const absoluteRoutePath = Path.resolve(ctx.config.appDirectory, route.file);


route.file is relative to the appDirectory.

wilcoxmd · 2025-02-12T16:45:27Z

integration/helpers/filesystem.ts

+const root = path.resolve(__dirname, "../..");
+const TMP_DIR = path.join(root, ".tmp/integration");
+
+export async function writeTestFiles(


This function, and the logic in createTestDirectory below were pulled from other files and just refactored into this file for reuse.

…d-route-typegen * upstream/dev: bump patch to minor for new API: `href` Type-safe href (remix-run#12994) docs: prerender/ssr:false (remix-run#13005) Skip action-only resource routes with prerender:true (remix-run#13004) Update docs for spa/prerendering Improvements to ssr:false + prerender scenarios (remix-run#12948)

…d-route-typegen * upstream/dev: (65 commits) Generate types for `virtual:react-router/server-build` (remix-run#13152) Add support for client context and middleware (unstable) (remix-run#12941) Add playground for `vite-plugin-cloudflare` (remix-run#13151) do not typegen params for layout routes with a corresponding index (remix-run#13131) (remix-run#13140) Fix types for `loaderData` and `actionData` that contain `Record`s (remix-run#13139) chore: format chore(dev): remove unused dependencies (remix-run#13134) Remove unused Vite file system watcher (remix-run#13133) Remove stale changesets cherry-picked into release-next for 7.2.0 Fix custom SSR build input with `serverBundles` (remix-run#13107) Skip resource route flow in dev mode when SPA mode is enabled (remix-run#13113) chore: format Add integration test for `vite-plugin-cloudflare` (remix-run#13099) Fix custom client `build.rollupOptions.output.entryFileNames` (remix-run#13098) Detect lazy route discovery manifest version mismatches and trigger reloads (remix-run#13061) Fix critical CSS with custom `Vite.DevEnvironment` (remix-run#13066) Fix usage of `prerender` option with `serverBundles` (remix-run#13082) Fix support for custom `build.assetsDir` (remix-run#13077) Add changeset for remix-run#13064 Only import the root route when SSRing SPA mode's index.html (remix-run#13023) ...

…d-route-typegen * upstream/dev: (55 commits) Fix root loader data on initial load redirects in SPA mode (remix-run#13222) Ensure ancestor pathless/index routes are loaded via manifest requests (remix-run#13203) Fix shoulRevalidate behavior in clientLoader-only routes (remix-run#13221) Stop leaking internal MiddlewareError implementation detail (remix-run#13180) Fix validation of split route modules for root route (remix-run#13238) Fix `RequestHandler` `loadContext` type when middleware is enabled (remix-run#13204) Change middleware return type from void to undefined (remix-run#13199) update docs home page add API docs Fix error message typo Fix Windows CI (remix-run#13215) Remove Vite server hooks in child compiler plugins (remix-run#13184) Support flexible ordering of Vite plugins that override SSR environment (remix-run#13183) chore: format chore: Update version for release (remix-run#13175) Exit prerelease mode chore: Update version for release (pre) (remix-run#13174) Fix JSDoc types for context (remix-run#13170) Remove middleware depth restrictions (remix-run#13172) minor language improvements in context/middleware decision doc ...

wilcoxmd · 2025-03-19T01:26:22Z

Hi @pcattori! Do you have any thoughts on this PR? Would love to merge it to prevent issues in our monorepo at Square. Seems like a few other folks have run into the same problem as well based on this issue comment and discord.

…d-route-typegen * upstream/dev: (56 commits) chore: format feat: unstable_subResourceIntegrity (remix-run#13163) Add lazy route property API, use for loading middleware (remix-run#13294) Add `rolldown-vite` playground (remix-run#13333) chore: Update version for release (remix-run#13322) Exit prerelease mode Update release notes Remove `react-router:override-optimize-deps` plugin (remix-run#13317) chore: format Add Wrangler v4 to `@react-router/dev` peer dep range (remix-run#13258) update changelog Handle custom base for critical CSS with Vite Env API (remix-run#13305) chore: Update version for release (pre) (remix-run#13312) Enter prerelease mode chore: format host parse (remix-run#13309) Fix middleware return types (remix-run#13311) more data docs fix Location link (remix-run#13291) Also fix the meta link ...

wilcoxmd · 2025-04-03T12:14:05Z

Hi @pcattori, just wanted check again for any feedback on this? Or @brophdawg11 perhaps? I noticed you added some labels to the linked issue yesterday, so was hoping that maybe you were doing some planning around this and that it could be a good time to consider merging or discussing further.

wilcoxmd mentioned this pull request Feb 11, 2025

Typegen generates files outside of .react-router when using routes imported from a library #12993

Open

wilcoxmd force-pushed the mwilcox/skip-imported-route-typegen branch 3 times, most recently from 635c44c to 88c709a Compare February 11, 2025 07:22

Add failing test for workspace route library

74fed50

Adds workspace routes fixture and a failing test

wilcoxmd force-pushed the mwilcox/skip-imported-route-typegen branch from 88c709a to 50d0f95 Compare February 11, 2025 07:37

wilcoxmd commented Feb 11, 2025

View reviewed changes

remix-cla-bot bot added the CLA Signed label Feb 12, 2025

wilcoxmd force-pushed the mwilcox/skip-imported-route-typegen branch 2 times, most recently from 2132477 to 725539b Compare February 12, 2025 16:28

wilcoxmd and others added 3 commits February 12, 2025 10:40

Only generate types for route modules in a projects app directory

6902a87

Add changeset

f8909be

Add username to contributors.yml

9d0dc64

wilcoxmd force-pushed the mwilcox/skip-imported-route-typegen branch from 725539b to 9d0dc64 Compare February 12, 2025 16:40

wilcoxmd commented Feb 12, 2025

View reviewed changes

wilcoxmd marked this pull request as ready for review February 12, 2025 17:06

pcattori self-assigned this Feb 12, 2025

wilcoxmd added 3 commits February 12, 2025 13:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Skip typegen for routes outside the app directory #12996

Skip typegen for routes outside the app directory #12996

wilcoxmd commented Feb 11, 2025 •

edited

Loading

changeset-bot bot commented Feb 11, 2025 •

edited

Loading

remix-cla-bot bot commented Feb 11, 2025

wilcoxmd Feb 11, 2025 •

edited

Loading

remix-cla-bot bot commented Feb 12, 2025

wilcoxmd Feb 12, 2025

wilcoxmd Feb 12, 2025

wilcoxmd commented Mar 19, 2025 •

edited

Loading

wilcoxmd commented Apr 3, 2025 •

edited

Loading

Skip typegen for routes outside the app directory #12996

Are you sure you want to change the base?

Skip typegen for routes outside the app directory #12996

Conversation

wilcoxmd commented Feb 11, 2025 • edited Loading

changeset-bot bot commented Feb 11, 2025 • edited Loading

🦋 Changeset detected

remix-cla-bot bot commented Feb 11, 2025

wilcoxmd Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

remix-cla-bot bot commented Feb 12, 2025

wilcoxmd Feb 12, 2025

Choose a reason for hiding this comment

wilcoxmd Feb 12, 2025

Choose a reason for hiding this comment

wilcoxmd commented Mar 19, 2025 • edited Loading

wilcoxmd commented Apr 3, 2025 • edited Loading

wilcoxmd commented Feb 11, 2025 •

edited

Loading

changeset-bot bot commented Feb 11, 2025 •

edited

Loading

wilcoxmd Feb 11, 2025 •

edited

Loading

wilcoxmd commented Mar 19, 2025 •

edited

Loading

wilcoxmd commented Apr 3, 2025 •

edited

Loading