From e38abb1d42742ca7db1b51da2143f07e1931d10d Mon Sep 17 00:00:00 2001 From: Manuel Schiller Date: Sat, 1 Mar 2025 01:56:16 +0100 Subject: [PATCH 1/4] fix: createFileRoute without path --- .../basic-file-based/src/routeTree.gen.ts | 88 +++++++++++++++++++ .../basic-file-based/src/routes/index.tsx | 2 +- .../src/routes/posts.$postId.tsx | 2 +- .../basic-file-based/src/routes/posts.tsx | 2 +- packages/react-router/src/fileRoute.ts | 10 ++- packages/react-router/src/index.tsx | 3 +- packages/react-router/vite.config.ts | 9 ++ packages/router-generator/src/generator.ts | 5 ++ packages/solid-router/src/fileRoute.ts | 10 ++- packages/solid-router/src/index.tsx | 3 +- packages/solid-router/vite.config.ts | 9 ++ 11 files changed, 132 insertions(+), 11 deletions(-) diff --git a/e2e/react-router/basic-file-based/src/routeTree.gen.ts b/e2e/react-router/basic-file-based/src/routeTree.gen.ts index 0cc7397492..f65d5a0339 100644 --- a/e2e/react-router/basic-file-based/src/routeTree.gen.ts +++ b/e2e/react-router/basic-file-based/src/routeTree.gen.ts @@ -432,6 +432,94 @@ declare module '@tanstack/react-router' { } } +declare module './routes/index' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/'> +} +declare module './routes/_layout' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/_layout'> +} +declare module './routes/anchor' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/anchor'> +} +declare module './routes/editing-a' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/editing-a'> +} +declare module './routes/editing-b' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/editing-b'> +} +declare module './routes/posts' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/posts'> +} +declare module './routes/(another-group)/onlyrouteinside' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/(another-group)/onlyrouteinside'> +} +declare module './routes/(group)' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)'> +} +declare module './routes/(group)/_layout' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)/_layout'> +} +declare module './routes/(group)/inside' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)/inside'> +} +declare module './routes/(group)/lazyinside' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)/lazyinside'> +} +declare module './routes/_layout/_layout-2' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/_layout/_layout-2'> +} +declare module './routes/posts.$postId' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/posts/$postId'> +} +declare module './routes/redirect/$target' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/$target'> +} +declare module './routes/structural-sharing.$enabled' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/structural-sharing/$enabled'> +} +declare module './routes/posts.index' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/posts/'> +} +declare module './routes/redirect/index' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/'> +} +declare module './routes/(group)/_layout.insidelayout' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)/_layout/insidelayout'> +} +declare module './routes/(group)/subfolder/inside' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)/subfolder/inside'> +} +declare module './routes/_layout/_layout-2/layout-a' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/_layout/_layout-2/layout-a'> +} +declare module './routes/_layout/_layout-2/layout-b' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/_layout/_layout-2/layout-b'> +} +declare module './routes/params.single.$value' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/params/single/$value'> +} +declare module './routes/posts_.$postId.edit' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/posts_/$postId/edit'> +} +declare module './routes/redirect/$target/via-beforeLoad' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/$target/via-beforeLoad'> +} +declare module './routes/redirect/$target/via-loader' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/$target/via-loader'> +} +declare module './routes/redirect/preload/first' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/preload/first'> +} +declare module './routes/redirect/preload/second' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/preload/second'> +} +declare module './routes/redirect/preload/third' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/preload/third'> +} +declare module './routes/redirect/$target/index' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/$target/'> +} + // Create and export the route tree interface LayoutLayout2RouteChildren { diff --git a/e2e/react-router/basic-file-based/src/routes/index.tsx b/e2e/react-router/basic-file-based/src/routes/index.tsx index eac82a9174..48a9c098b7 100644 --- a/e2e/react-router/basic-file-based/src/routes/index.tsx +++ b/e2e/react-router/basic-file-based/src/routes/index.tsx @@ -1,7 +1,7 @@ import * as React from 'react' import { createFileRoute } from '@tanstack/react-router' -export const Route = createFileRoute('/')({ +export const Route = createFileRoute()({ component: Home, }) diff --git a/e2e/react-router/basic-file-based/src/routes/posts.$postId.tsx b/e2e/react-router/basic-file-based/src/routes/posts.$postId.tsx index df51873ddf..d4346c6061 100644 --- a/e2e/react-router/basic-file-based/src/routes/posts.$postId.tsx +++ b/e2e/react-router/basic-file-based/src/routes/posts.$postId.tsx @@ -3,7 +3,7 @@ import { ErrorComponent, createFileRoute } from '@tanstack/react-router' import { fetchPost } from '../posts' import type { ErrorComponentProps } from '@tanstack/react-router' -export const Route = createFileRoute('/posts/$postId')({ +export const Route = createFileRoute()({ loader: async ({ params: { postId } }) => fetchPost(postId), errorComponent: PostErrorComponent, notFoundComponent: () => { diff --git a/e2e/react-router/basic-file-based/src/routes/posts.tsx b/e2e/react-router/basic-file-based/src/routes/posts.tsx index 360a165d91..9ce45be058 100644 --- a/e2e/react-router/basic-file-based/src/routes/posts.tsx +++ b/e2e/react-router/basic-file-based/src/routes/posts.tsx @@ -2,7 +2,7 @@ import * as React from 'react' import { Link, Outlet, createFileRoute } from '@tanstack/react-router' import { fetchPosts } from '../posts' -export const Route = createFileRoute('/posts')({ +export const Route = createFileRoute()({ loader: fetchPosts, component: PostsComponent, }) diff --git a/packages/react-router/src/fileRoute.ts b/packages/react-router/src/fileRoute.ts index bc8cc77484..788e8c5995 100644 --- a/packages/react-router/src/fileRoute.ts +++ b/packages/react-router/src/fileRoute.ts @@ -33,7 +33,11 @@ import type { UseLoaderDepsRoute } from './useLoaderDeps' import type { UseLoaderDataRoute } from './useLoaderData' import type { UseRouteContextRoute } from './useRouteContext' -export function createFileRoute< +export interface createFileRouteGlobal { + (x: any): void +} + +export function createFileRouteImpl< TFilePath extends keyof FileRoutesByPath, TParentRoute extends AnyRoute = FileRoutesByPath[TFilePath]['parentRoute'], TId extends RouteConstraints['TId'] = FileRoutesByPath[TFilePath]['id'], @@ -41,7 +45,7 @@ export function createFileRoute< TFullPath extends RouteConstraints['TFullPath'] = FileRoutesByPath[TFilePath]['fullPath'], >( - path: TFilePath, + path?: TFilePath, ): FileRoute['createRoute'] { return new FileRoute(path, { silent: true, @@ -63,7 +67,7 @@ export class FileRoute< silent?: boolean constructor( - public path: TFilePath, + public path?: TFilePath, _opts?: { silent: boolean }, ) { this.silent = _opts?.silent diff --git a/packages/react-router/src/index.tsx b/packages/react-router/src/index.tsx index e782caabbc..bf3006df89 100644 --- a/packages/react-router/src/index.tsx +++ b/packages/react-router/src/index.tsx @@ -148,7 +148,8 @@ export { CatchBoundary, ErrorComponent } from './CatchBoundary' export { FileRoute, - createFileRoute, + createFileRouteImpl, + createFileRouteImpl as createFileRoute, FileRouteLoader, LazyRoute, createLazyRoute, diff --git a/packages/react-router/vite.config.ts b/packages/react-router/vite.config.ts index b53262bcf2..4fe28b540a 100644 --- a/packages/react-router/vite.config.ts +++ b/packages/react-router/vite.config.ts @@ -21,5 +21,14 @@ export default mergeConfig( tanstackViteConfig({ entry: './src/index.tsx', srcDir: './src', + beforeWriteDeclarationFile: (filePath, content) => { + if (filePath.includes('index.d.ts')) { + return content.replace( + `createFileRouteImpl as createFileRoute`, + `createFileRouteGlobal as createFileRoute`, + ) + } + return content + }, }), ) diff --git a/packages/router-generator/src/generator.ts b/packages/router-generator/src/generator.ts index a9dcf7ffe1..fb95b7868c 100644 --- a/packages/router-generator/src/generator.ts +++ b/packages/router-generator/src/generator.ts @@ -636,6 +636,11 @@ export async function generator(config: Config, root: string) { } }`, ]), + routeNodes.map((routeNode) => { + return `declare module './${getImportPath(routeNode)}' { + const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'${routeNode.routePath}'> +}` + }).join('\n'), '// Create and export the route tree', routeConfigChildrenText, ...(TYPES_DISABLED diff --git a/packages/solid-router/src/fileRoute.ts b/packages/solid-router/src/fileRoute.ts index a176617837..75e26a9782 100644 --- a/packages/solid-router/src/fileRoute.ts +++ b/packages/solid-router/src/fileRoute.ts @@ -33,7 +33,11 @@ import type { UseLoaderDepsRoute } from './useLoaderDeps' import type { UseLoaderDataRoute } from './useLoaderData' import type { UseRouteContextRoute } from './useRouteContext' -export function createFileRoute< +export interface createFileRouteGlobal { + (x: any): void +} + +export function createFileRouteImpl< TFilePath extends keyof FileRoutesByPath, TParentRoute extends AnyRoute = FileRoutesByPath[TFilePath]['parentRoute'], TId extends RouteConstraints['TId'] = FileRoutesByPath[TFilePath]['id'], @@ -41,7 +45,7 @@ export function createFileRoute< TFullPath extends RouteConstraints['TFullPath'] = FileRoutesByPath[TFilePath]['fullPath'], >( - path: TFilePath, + path?: TFilePath, ): FileRoute['createRoute'] { return new FileRoute(path, { silent: true, @@ -63,7 +67,7 @@ export class FileRoute< silent?: boolean constructor( - public path: TFilePath, + public path?: TFilePath, _opts?: { silent: boolean }, ) { this.silent = _opts?.silent diff --git a/packages/solid-router/src/index.tsx b/packages/solid-router/src/index.tsx index ac08c081f1..34a30a3504 100644 --- a/packages/solid-router/src/index.tsx +++ b/packages/solid-router/src/index.tsx @@ -209,7 +209,8 @@ export { CatchBoundary, ErrorComponent } from './CatchBoundary' export { FileRoute, - createFileRoute, + createFileRouteImpl, + createFileRouteImpl as createFileRoute, FileRouteLoader, LazyRoute, createLazyRoute, diff --git a/packages/solid-router/vite.config.ts b/packages/solid-router/vite.config.ts index 3a3a4f2edf..197466bb5a 100644 --- a/packages/solid-router/vite.config.ts +++ b/packages/solid-router/vite.config.ts @@ -21,5 +21,14 @@ export default mergeConfig( tanstackViteConfig({ entry: './src/index.tsx', srcDir: './src', + beforeWriteDeclarationFile: (filePath, content) => { + if (filePath.includes('index.d.ts')) { + return content.replace( + `createFileRouteImpl as createFileRoute`, + `createFileRouteGlobal as createFileRoute`, + ) + } + return content + }, }), ) From 42329f7b2bdb1dcfd445337c1e00185286664698 Mon Sep 17 00:00:00 2001 From: Manuel Schiller Date: Sat, 1 Mar 2025 02:30:43 +0100 Subject: [PATCH 2/4] even less verbose --- .../basic-file-based/src/routes/(group)/lazyinside.tsx | 2 +- e2e/react-router/basic-file-based/src/routes/index.tsx | 3 +-- packages/react-router/src/fileRoute.ts | 7 ++++++- packages/react-router/src/router.ts | 7 +++++++ 4 files changed, 15 insertions(+), 4 deletions(-) diff --git a/e2e/react-router/basic-file-based/src/routes/(group)/lazyinside.tsx b/e2e/react-router/basic-file-based/src/routes/(group)/lazyinside.tsx index 0f52a40d98..7cb5fe027b 100644 --- a/e2e/react-router/basic-file-based/src/routes/(group)/lazyinside.tsx +++ b/e2e/react-router/basic-file-based/src/routes/(group)/lazyinside.tsx @@ -2,6 +2,6 @@ import { createFileRoute } from '@tanstack/react-router' import { z } from 'zod' import { zodValidator } from '@tanstack/zod-adapter' -export const Route = createFileRoute('/(group)/lazyinside')({ +export const Route = createFileRoute({ validateSearch: zodValidator(z.object({ hello: z.string().optional() })), }) diff --git a/e2e/react-router/basic-file-based/src/routes/index.tsx b/e2e/react-router/basic-file-based/src/routes/index.tsx index 48a9c098b7..b23956ae17 100644 --- a/e2e/react-router/basic-file-based/src/routes/index.tsx +++ b/e2e/react-router/basic-file-based/src/routes/index.tsx @@ -1,7 +1,6 @@ import * as React from 'react' -import { createFileRoute } from '@tanstack/react-router' -export const Route = createFileRoute()({ +export const Route = createFileRoute({ component: Home, }) diff --git a/packages/react-router/src/fileRoute.ts b/packages/react-router/src/fileRoute.ts index 788e8c5995..7ca1f31d15 100644 --- a/packages/react-router/src/fileRoute.ts +++ b/packages/react-router/src/fileRoute.ts @@ -45,8 +45,13 @@ export function createFileRouteImpl< TFullPath extends RouteConstraints['TFullPath'] = FileRoutesByPath[TFilePath]['fullPath'], >( - path?: TFilePath, + path?: TFilePath | any ): FileRoute['createRoute'] { + if (typeof path === 'object') { + return new FileRoute(path, { + silent: true, + }).createRoute(path) as any + } return new FileRoute(path, { silent: true, }).createRoute diff --git a/packages/react-router/src/router.ts b/packages/react-router/src/router.ts index 00ef4ba88b..7b05a73e95 100644 --- a/packages/react-router/src/router.ts +++ b/packages/react-router/src/router.ts @@ -30,6 +30,7 @@ import { isRedirect, isResolvedRedirect } from './redirects' import { isNotFound } from './not-found' import { setupScrollRestoration } from './scroll-restoration' +import { createFileRouteImpl } from './fileRoute' import type * as React from 'react' import type { HistoryLocation, @@ -3078,3 +3079,9 @@ export function getInitialRouterState( statusCode: 200, } } + +if (typeof globalThis !== 'undefined') { + (globalThis as any).createFileRoute = createFileRouteImpl +} else if (typeof window !== 'undefined') { + (window as any).createFileRoute = createFileRouteImpl +} \ No newline at end of file From f491a8c4547eed2af4b5a299759be8de0950387b Mon Sep 17 00:00:00 2001 From: Manuel Schiller Date: Sat, 1 Mar 2025 02:46:35 +0100 Subject: [PATCH 3/4] less verbose --- .../basic-file-based/src/routeTree.gen.ts | 116 +++++++++++++----- .../(another-group)/onlyrouteinside.tsx | 2 +- .../routes/(group)/_layout.insidelayout.tsx | 2 +- .../src/routes/(group)/_layout.tsx | 2 +- .../src/routes/(group)/inside.tsx | 2 +- .../src/routes/(group)/lazyinside.lazy.tsx | 2 +- .../src/routes/(group)/subfolder/inside.tsx | 2 +- .../basic-file-based/src/routes/_layout.tsx | 2 +- .../src/routes/_layout/_layout-2.tsx | 2 +- .../src/routes/_layout/_layout-2/layout-a.tsx | 2 +- .../src/routes/_layout/_layout-2/layout-b.tsx | 2 +- .../basic-file-based/src/routes/anchor.tsx | 2 +- .../basic-file-based/src/routes/editing-a.tsx | 2 +- .../basic-file-based/src/routes/editing-b.tsx | 2 +- .../src/routes/params.single.$value.tsx | 2 +- .../src/routes/posts.$postId.tsx | 2 +- .../src/routes/posts.index.tsx | 2 +- .../src/routes/posts_.$postId.edit.tsx | 2 +- .../src/routes/redirect/$target.tsx | 2 +- .../src/routes/redirect/$target/index.tsx | 2 +- .../redirect/$target/via-beforeLoad.tsx | 2 +- .../routes/redirect/$target/via-loader.tsx | 2 +- .../src/routes/redirect/index.tsx | 2 +- .../src/routes/redirect/preload/first.tsx | 2 +- .../src/routes/redirect/preload/second.tsx | 2 +- .../src/routes/redirect/preload/third.tsx | 2 +- .../routes/structural-sharing.$enabled.tsx | 2 +- packages/router-generator/src/generator.ts | 4 +- 28 files changed, 115 insertions(+), 57 deletions(-) diff --git a/e2e/react-router/basic-file-based/src/routeTree.gen.ts b/e2e/react-router/basic-file-based/src/routeTree.gen.ts index f65d5a0339..e15a1921e5 100644 --- a/e2e/react-router/basic-file-based/src/routeTree.gen.ts +++ b/e2e/react-router/basic-file-based/src/routeTree.gen.ts @@ -433,91 +433,149 @@ declare module '@tanstack/react-router' { } declare module './routes/index' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/'> + > } declare module './routes/_layout' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/_layout'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/_layout'> + > } declare module './routes/anchor' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/anchor'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/anchor'> + > } declare module './routes/editing-a' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/editing-a'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/editing-a'> + > } declare module './routes/editing-b' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/editing-b'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/editing-b'> + > } declare module './routes/posts' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/posts'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/posts'> + > } declare module './routes/(another-group)/onlyrouteinside' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/(another-group)/onlyrouteinside'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/(another-group)/onlyrouteinside'> + > } declare module './routes/(group)' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)'> + > } declare module './routes/(group)/_layout' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)/_layout'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)/_layout'> + > } declare module './routes/(group)/inside' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)/inside'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)/inside'> + > } declare module './routes/(group)/lazyinside' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)/lazyinside'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)/lazyinside'> + > } declare module './routes/_layout/_layout-2' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/_layout/_layout-2'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/_layout/_layout-2'> + > } declare module './routes/posts.$postId' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/posts/$postId'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/posts/$postId'> + > } declare module './routes/redirect/$target' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/$target'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/$target'> + > } declare module './routes/structural-sharing.$enabled' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/structural-sharing/$enabled'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/structural-sharing/$enabled'> + > } declare module './routes/posts.index' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/posts/'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/posts/'> + > } declare module './routes/redirect/index' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/'> + > } declare module './routes/(group)/_layout.insidelayout' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)/_layout/insidelayout'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)/_layout/insidelayout'> + > } declare module './routes/(group)/subfolder/inside' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)/subfolder/inside'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/(group)/subfolder/inside'> + > } declare module './routes/_layout/_layout-2/layout-a' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/_layout/_layout-2/layout-a'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/_layout/_layout-2/layout-a'> + > } declare module './routes/_layout/_layout-2/layout-b' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/_layout/_layout-2/layout-b'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/_layout/_layout-2/layout-b'> + > } declare module './routes/params.single.$value' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/params/single/$value'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/params/single/$value'> + > } declare module './routes/posts_.$postId.edit' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/posts_/$postId/edit'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/posts_/$postId/edit'> + > } declare module './routes/redirect/$target/via-beforeLoad' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/$target/via-beforeLoad'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/$target/via-beforeLoad'> + > } declare module './routes/redirect/$target/via-loader' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/$target/via-loader'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/$target/via-loader'> + > } declare module './routes/redirect/preload/first' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/preload/first'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/preload/first'> + > } declare module './routes/redirect/preload/second' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/preload/second'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/preload/second'> + > } declare module './routes/redirect/preload/third' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/preload/third'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/preload/third'> + > } declare module './routes/redirect/$target/index' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/$target/'> + const createFileRoute: ReturnType< + typeof import('@tanstack/react-router').createFileRouteImpl<'/redirect/$target/'> + > } // Create and export the route tree diff --git a/e2e/react-router/basic-file-based/src/routes/(another-group)/onlyrouteinside.tsx b/e2e/react-router/basic-file-based/src/routes/(another-group)/onlyrouteinside.tsx index bbd1eedb6f..bcc87859bb 100644 --- a/e2e/react-router/basic-file-based/src/routes/(another-group)/onlyrouteinside.tsx +++ b/e2e/react-router/basic-file-based/src/routes/(another-group)/onlyrouteinside.tsx @@ -4,7 +4,7 @@ import { zodValidator } from '@tanstack/zod-adapter' const routeApi = getRouteApi('/(another-group)/onlyrouteinside') -export const Route = createFileRoute('/(another-group)/onlyrouteinside')({ +export const Route = createFileRoute({ validateSearch: zodValidator(z.object({ hello: z.string().optional() })), component: () => { const searchViaHook = useSearch({ diff --git a/e2e/react-router/basic-file-based/src/routes/(group)/_layout.insidelayout.tsx b/e2e/react-router/basic-file-based/src/routes/(group)/_layout.insidelayout.tsx index 2975baedc9..4e1ddc648c 100644 --- a/e2e/react-router/basic-file-based/src/routes/(group)/_layout.insidelayout.tsx +++ b/e2e/react-router/basic-file-based/src/routes/(group)/_layout.insidelayout.tsx @@ -4,7 +4,7 @@ import { zodValidator } from '@tanstack/zod-adapter' const routeApi = getRouteApi('/(group)/_layout/insidelayout') -export const Route = createFileRoute('/(group)/_layout/insidelayout')({ +export const Route = createFileRoute({ validateSearch: zodValidator(z.object({ hello: z.string().optional() })), component: () => { const searchViaHook = useSearch({ from: '/(group)/_layout/insidelayout' }) diff --git a/e2e/react-router/basic-file-based/src/routes/(group)/_layout.tsx b/e2e/react-router/basic-file-based/src/routes/(group)/_layout.tsx index 4b755791c0..31f57f0fb5 100644 --- a/e2e/react-router/basic-file-based/src/routes/(group)/_layout.tsx +++ b/e2e/react-router/basic-file-based/src/routes/(group)/_layout.tsx @@ -1,6 +1,6 @@ import { Outlet, createFileRoute } from '@tanstack/react-router' -export const Route = createFileRoute('/(group)/_layout')({ +export const Route = createFileRoute({ component: () => ( <>
/(group)/_layout!
diff --git a/e2e/react-router/basic-file-based/src/routes/(group)/inside.tsx b/e2e/react-router/basic-file-based/src/routes/(group)/inside.tsx index 356ff96003..dd95cde83e 100644 --- a/e2e/react-router/basic-file-based/src/routes/(group)/inside.tsx +++ b/e2e/react-router/basic-file-based/src/routes/(group)/inside.tsx @@ -4,7 +4,7 @@ import { zodValidator } from '@tanstack/zod-adapter' const routeApi = getRouteApi('/(group)/inside') -export const Route = createFileRoute('/(group)/inside')({ +export const Route = createFileRoute({ validateSearch: zodValidator(z.object({ hello: z.string().optional() })), component: () => { const searchViaHook = useSearch({ from: '/(group)/inside' }) diff --git a/e2e/react-router/basic-file-based/src/routes/(group)/lazyinside.lazy.tsx b/e2e/react-router/basic-file-based/src/routes/(group)/lazyinside.lazy.tsx index 527be4f520..1597742495 100644 --- a/e2e/react-router/basic-file-based/src/routes/(group)/lazyinside.lazy.tsx +++ b/e2e/react-router/basic-file-based/src/routes/(group)/lazyinside.lazy.tsx @@ -6,7 +6,7 @@ import { const routeApi = getRouteApi('/(group)/lazyinside') -export const Route = createLazyFileRoute('/(group)/lazyinside')({ +export const Route = createLazyFileRoute({ component: () => { const searchViaHook = useSearch({ from: '/(group)/lazyinside' }) const searchViaRouteHook = Route.useSearch() diff --git a/e2e/react-router/basic-file-based/src/routes/(group)/subfolder/inside.tsx b/e2e/react-router/basic-file-based/src/routes/(group)/subfolder/inside.tsx index 3a4a051e8a..b148a408ae 100644 --- a/e2e/react-router/basic-file-based/src/routes/(group)/subfolder/inside.tsx +++ b/e2e/react-router/basic-file-based/src/routes/(group)/subfolder/inside.tsx @@ -4,7 +4,7 @@ import { zodValidator } from '@tanstack/zod-adapter' const routeApi = getRouteApi('/(group)/subfolder/inside') -export const Route = createFileRoute('/(group)/subfolder/inside')({ +export const Route = createFileRoute({ validateSearch: zodValidator(z.object({ hello: z.string().optional() })), component: () => { const searchViaHook = useSearch({ from: '/(group)/subfolder/inside' }) diff --git a/e2e/react-router/basic-file-based/src/routes/_layout.tsx b/e2e/react-router/basic-file-based/src/routes/_layout.tsx index 02ddbb1cd9..582cfef366 100644 --- a/e2e/react-router/basic-file-based/src/routes/_layout.tsx +++ b/e2e/react-router/basic-file-based/src/routes/_layout.tsx @@ -1,6 +1,6 @@ import { Outlet, createFileRoute } from '@tanstack/react-router' -export const Route = createFileRoute('/_layout')({ +export const Route = createFileRoute({ component: LayoutComponent, }) diff --git a/e2e/react-router/basic-file-based/src/routes/_layout/_layout-2.tsx b/e2e/react-router/basic-file-based/src/routes/_layout/_layout-2.tsx index 3b7dbf2903..c4b1085ae0 100644 --- a/e2e/react-router/basic-file-based/src/routes/_layout/_layout-2.tsx +++ b/e2e/react-router/basic-file-based/src/routes/_layout/_layout-2.tsx @@ -1,6 +1,6 @@ import { Link, Outlet, createFileRoute } from '@tanstack/react-router' -export const Route = createFileRoute('/_layout/_layout-2')({ +export const Route = createFileRoute({ component: LayoutComponent, }) diff --git a/e2e/react-router/basic-file-based/src/routes/_layout/_layout-2/layout-a.tsx b/e2e/react-router/basic-file-based/src/routes/_layout/_layout-2/layout-a.tsx index 61e19b4d9f..0eef1bea7d 100644 --- a/e2e/react-router/basic-file-based/src/routes/_layout/_layout-2/layout-a.tsx +++ b/e2e/react-router/basic-file-based/src/routes/_layout/_layout-2/layout-a.tsx @@ -1,6 +1,6 @@ import { createFileRoute } from '@tanstack/react-router' -export const Route = createFileRoute('/_layout/_layout-2/layout-a')({ +export const Route = createFileRoute({ component: LayoutAComponent, }) diff --git a/e2e/react-router/basic-file-based/src/routes/_layout/_layout-2/layout-b.tsx b/e2e/react-router/basic-file-based/src/routes/_layout/_layout-2/layout-b.tsx index cceed1fb9a..35e70a9a98 100644 --- a/e2e/react-router/basic-file-based/src/routes/_layout/_layout-2/layout-b.tsx +++ b/e2e/react-router/basic-file-based/src/routes/_layout/_layout-2/layout-b.tsx @@ -1,6 +1,6 @@ import { createFileRoute } from '@tanstack/react-router' -export const Route = createFileRoute('/_layout/_layout-2/layout-b')({ +export const Route = createFileRoute({ component: LayoutBComponent, }) diff --git a/e2e/react-router/basic-file-based/src/routes/anchor.tsx b/e2e/react-router/basic-file-based/src/routes/anchor.tsx index 93975ba621..d3ca808330 100644 --- a/e2e/react-router/basic-file-based/src/routes/anchor.tsx +++ b/e2e/react-router/basic-file-based/src/routes/anchor.tsx @@ -6,7 +6,7 @@ import { useNavigate, } from '@tanstack/react-router' -export const Route = createFileRoute('/anchor')({ +export const Route = createFileRoute({ component: AnchorComponent, }) diff --git a/e2e/react-router/basic-file-based/src/routes/editing-a.tsx b/e2e/react-router/basic-file-based/src/routes/editing-a.tsx index cecd0dfed1..0f65f8bf72 100644 --- a/e2e/react-router/basic-file-based/src/routes/editing-a.tsx +++ b/e2e/react-router/basic-file-based/src/routes/editing-a.tsx @@ -1,7 +1,7 @@ import * as React from 'react' import { createFileRoute, useBlocker } from '@tanstack/react-router' -export const Route = createFileRoute('/editing-a')({ +export const Route = createFileRoute({ component: RouteComponent, }) diff --git a/e2e/react-router/basic-file-based/src/routes/editing-b.tsx b/e2e/react-router/basic-file-based/src/routes/editing-b.tsx index 1a85e72e26..ec883811f4 100644 --- a/e2e/react-router/basic-file-based/src/routes/editing-b.tsx +++ b/e2e/react-router/basic-file-based/src/routes/editing-b.tsx @@ -1,7 +1,7 @@ import * as React from 'react' import { createFileRoute, useBlocker } from '@tanstack/react-router' -export const Route = createFileRoute('/editing-b')({ +export const Route = createFileRoute({ component: RouteComponent, }) diff --git a/e2e/react-router/basic-file-based/src/routes/params.single.$value.tsx b/e2e/react-router/basic-file-based/src/routes/params.single.$value.tsx index b5761e839e..a2cd180ce8 100644 --- a/e2e/react-router/basic-file-based/src/routes/params.single.$value.tsx +++ b/e2e/react-router/basic-file-based/src/routes/params.single.$value.tsx @@ -1,7 +1,7 @@ import * as React from 'react' import { Link, createFileRoute } from '@tanstack/react-router' -export const Route = createFileRoute('/params/single/$value')({ +export const Route = createFileRoute({ component: RouteComponent, }) diff --git a/e2e/react-router/basic-file-based/src/routes/posts.$postId.tsx b/e2e/react-router/basic-file-based/src/routes/posts.$postId.tsx index d4346c6061..8401ba1e0f 100644 --- a/e2e/react-router/basic-file-based/src/routes/posts.$postId.tsx +++ b/e2e/react-router/basic-file-based/src/routes/posts.$postId.tsx @@ -3,7 +3,7 @@ import { ErrorComponent, createFileRoute } from '@tanstack/react-router' import { fetchPost } from '../posts' import type { ErrorComponentProps } from '@tanstack/react-router' -export const Route = createFileRoute()({ +export const Route = createFileRoute({ loader: async ({ params: { postId } }) => fetchPost(postId), errorComponent: PostErrorComponent, notFoundComponent: () => { diff --git a/e2e/react-router/basic-file-based/src/routes/posts.index.tsx b/e2e/react-router/basic-file-based/src/routes/posts.index.tsx index ab89fb5a62..8de87f515a 100644 --- a/e2e/react-router/basic-file-based/src/routes/posts.index.tsx +++ b/e2e/react-router/basic-file-based/src/routes/posts.index.tsx @@ -1,7 +1,7 @@ import * as React from 'react' import { createFileRoute } from '@tanstack/react-router' -export const Route = createFileRoute('/posts/')({ +export const Route = createFileRoute({ component: PostsIndexComponent, }) diff --git a/e2e/react-router/basic-file-based/src/routes/posts_.$postId.edit.tsx b/e2e/react-router/basic-file-based/src/routes/posts_.$postId.edit.tsx index 44a62b0004..b05da729bf 100644 --- a/e2e/react-router/basic-file-based/src/routes/posts_.$postId.edit.tsx +++ b/e2e/react-router/basic-file-based/src/routes/posts_.$postId.edit.tsx @@ -1,6 +1,6 @@ import { createFileRoute, getRouteApi, useParams } from '@tanstack/react-router' -export const Route = createFileRoute('/posts_/$postId/edit')({ +export const Route = createFileRoute({ component: PostEditPage, }) diff --git a/e2e/react-router/basic-file-based/src/routes/redirect/$target.tsx b/e2e/react-router/basic-file-based/src/routes/redirect/$target.tsx index 686f1c7056..c7c9b80108 100644 --- a/e2e/react-router/basic-file-based/src/routes/redirect/$target.tsx +++ b/e2e/react-router/basic-file-based/src/routes/redirect/$target.tsx @@ -1,7 +1,7 @@ import { createFileRoute, retainSearchParams } from '@tanstack/react-router' import z from 'zod' -export const Route = createFileRoute('/redirect/$target')({ +export const Route = createFileRoute({ params: { parse: (p) => z diff --git a/e2e/react-router/basic-file-based/src/routes/redirect/$target/index.tsx b/e2e/react-router/basic-file-based/src/routes/redirect/$target/index.tsx index 57760cec88..4069e261b1 100644 --- a/e2e/react-router/basic-file-based/src/routes/redirect/$target/index.tsx +++ b/e2e/react-router/basic-file-based/src/routes/redirect/$target/index.tsx @@ -1,6 +1,6 @@ import { Link, createFileRoute } from '@tanstack/react-router' -export const Route = createFileRoute('/redirect/$target/')({ +export const Route = createFileRoute({ component: () => { const preload = Route.useSearch({ select: (s) => s.preload }) return ( diff --git a/e2e/react-router/basic-file-based/src/routes/redirect/$target/via-beforeLoad.tsx b/e2e/react-router/basic-file-based/src/routes/redirect/$target/via-beforeLoad.tsx index 14a2492331..8ab3dff8e5 100644 --- a/e2e/react-router/basic-file-based/src/routes/redirect/$target/via-beforeLoad.tsx +++ b/e2e/react-router/basic-file-based/src/routes/redirect/$target/via-beforeLoad.tsx @@ -1,6 +1,6 @@ import { createFileRoute, redirect } from '@tanstack/react-router' -export const Route = createFileRoute('/redirect/$target/via-beforeLoad')({ +export const Route = createFileRoute({ beforeLoad: ({ params: { target }, search: { reloadDocument, externalHost }, diff --git a/e2e/react-router/basic-file-based/src/routes/redirect/$target/via-loader.tsx b/e2e/react-router/basic-file-based/src/routes/redirect/$target/via-loader.tsx index 9e6a3fc9db..0269dc1fa7 100644 --- a/e2e/react-router/basic-file-based/src/routes/redirect/$target/via-loader.tsx +++ b/e2e/react-router/basic-file-based/src/routes/redirect/$target/via-loader.tsx @@ -1,6 +1,6 @@ import { createFileRoute, redirect } from '@tanstack/react-router' -export const Route = createFileRoute('/redirect/$target/via-loader')({ +export const Route = createFileRoute({ loaderDeps: ({ search: { reloadDocument, externalHost } }) => ({ reloadDocument, externalHost, diff --git a/e2e/react-router/basic-file-based/src/routes/redirect/index.tsx b/e2e/react-router/basic-file-based/src/routes/redirect/index.tsx index c0b26a1df4..a420a4ea61 100644 --- a/e2e/react-router/basic-file-based/src/routes/redirect/index.tsx +++ b/e2e/react-router/basic-file-based/src/routes/redirect/index.tsx @@ -1,6 +1,6 @@ import { Link, createFileRoute } from '@tanstack/react-router' -export const Route = createFileRoute('/redirect/')({ +export const Route = createFileRoute({ component: () => (
{ await new Promise((r) => setTimeout(r, 1000)) throw redirect({ from: Route.fullPath, to: '../third' }) diff --git a/e2e/react-router/basic-file-based/src/routes/redirect/preload/third.tsx b/e2e/react-router/basic-file-based/src/routes/redirect/preload/third.tsx index e882d29e69..4de62f9e03 100644 --- a/e2e/react-router/basic-file-based/src/routes/redirect/preload/third.tsx +++ b/e2e/react-router/basic-file-based/src/routes/redirect/preload/third.tsx @@ -1,6 +1,6 @@ import { createFileRoute } from '@tanstack/react-router' -export const Route = createFileRoute('/redirect/preload/third')({ +export const Route = createFileRoute({ component: RouteComponent, }) diff --git a/e2e/react-router/basic-file-based/src/routes/structural-sharing.$enabled.tsx b/e2e/react-router/basic-file-based/src/routes/structural-sharing.$enabled.tsx index 4a477f7ccd..8649bc38c1 100644 --- a/e2e/react-router/basic-file-based/src/routes/structural-sharing.$enabled.tsx +++ b/e2e/react-router/basic-file-based/src/routes/structural-sharing.$enabled.tsx @@ -17,7 +17,7 @@ const enabledSchema = { }, z.boolean()), } -export const Route = createFileRoute('/structural-sharing/$enabled')({ +export const Route = createFileRoute({ component: RouteComponent, params: { parse: (p) => z.object(enabledSchema).parse(p), diff --git a/packages/router-generator/src/generator.ts b/packages/router-generator/src/generator.ts index fb95b7868c..d718ac6e87 100644 --- a/packages/router-generator/src/generator.ts +++ b/packages/router-generator/src/generator.ts @@ -257,7 +257,7 @@ export async function generator(config: Config, root: string) { .replace( /create(Lazy)?FileRoute(\(\s*['"])([^\s]*)(['"],?\s*\))/g, (_, __, p2, ___, p4) => - `${node.isLazy ? 'createLazyFileRoute' : 'createFileRoute'}${p2}${escapedRoutePath}${p4}`, + `${node.isLazy ? 'createLazyFileRoute' : 'createFileRoute'}`, ) } @@ -638,7 +638,7 @@ export async function generator(config: Config, root: string) { ]), routeNodes.map((routeNode) => { return `declare module './${getImportPath(routeNode)}' { - const createFileRoute: typeof import('@tanstack/react-router').createFileRouteImpl<'${routeNode.routePath}'> + const createFileRoute: ReturnType> }` }).join('\n'), '// Create and export the route tree', From 494ac417766be324b7ab3dec08c706f5baded0e2 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Sat, 1 Mar 2025 08:05:48 +0000 Subject: [PATCH 4/4] ci: apply automated fixes --- packages/react-router/src/fileRoute.ts | 2 +- packages/react-router/src/router.ts | 6 +++--- packages/router-generator/src/generator.ts | 8 +++++--- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/packages/react-router/src/fileRoute.ts b/packages/react-router/src/fileRoute.ts index 7ca1f31d15..2bd174f27d 100644 --- a/packages/react-router/src/fileRoute.ts +++ b/packages/react-router/src/fileRoute.ts @@ -45,7 +45,7 @@ export function createFileRouteImpl< TFullPath extends RouteConstraints['TFullPath'] = FileRoutesByPath[TFilePath]['fullPath'], >( - path?: TFilePath | any + path?: TFilePath | any, ): FileRoute['createRoute'] { if (typeof path === 'object') { return new FileRoute(path, { diff --git a/packages/react-router/src/router.ts b/packages/react-router/src/router.ts index 7b05a73e95..49fada1f6d 100644 --- a/packages/react-router/src/router.ts +++ b/packages/react-router/src/router.ts @@ -3081,7 +3081,7 @@ export function getInitialRouterState( } if (typeof globalThis !== 'undefined') { - (globalThis as any).createFileRoute = createFileRouteImpl + ;(globalThis as any).createFileRoute = createFileRouteImpl } else if (typeof window !== 'undefined') { - (window as any).createFileRoute = createFileRouteImpl -} \ No newline at end of file + ;(window as any).createFileRoute = createFileRouteImpl +} diff --git a/packages/router-generator/src/generator.ts b/packages/router-generator/src/generator.ts index d718ac6e87..f3d5b59548 100644 --- a/packages/router-generator/src/generator.ts +++ b/packages/router-generator/src/generator.ts @@ -636,11 +636,13 @@ export async function generator(config: Config, root: string) { } }`, ]), - routeNodes.map((routeNode) => { - return `declare module './${getImportPath(routeNode)}' { + routeNodes + .map((routeNode) => { + return `declare module './${getImportPath(routeNode)}' { const createFileRoute: ReturnType> }` - }).join('\n'), + }) + .join('\n'), '// Create and export the route tree', routeConfigChildrenText, ...(TYPES_DISABLED