Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
N
next.js
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Alex
next.js
Commits
4efa10f0
Unverified
Commit
4efa10f0
authored
Aug 18, 2025
by
Jiachi Liu
Committed by
GitHub
Aug 18, 2025
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
[type] dynamic skip generating unused types (#82755)
parent
a90827be
Hide whitespace changes
Inline
Side-by-side
Showing
8 changed files
with
244 additions
and
33 deletions
+244
-33
typegen.ts
packages/next/src/server/lib/router-utils/typegen.ts
+106
-32
typed-routes.test.ts
test/e2e/app-dir/typed-routes/typed-routes.test.ts
+1
-1
.gitignore
test/production/app-dir/types-gen-nounuselocal/.gitignore
+1
-0
layout.tsx
.../production/app-dir/types-gen-nounuselocal/app/layout.tsx
+8
-0
page.tsx
test/production/app-dir/types-gen-nounuselocal/app/page.tsx
+3
-0
next.config.js
.../production/app-dir/types-gen-nounuselocal/next.config.js
+6
-0
tsconfig.json
test/production/app-dir/types-gen-nounuselocal/tsconfig.json
+28
-0
types-gen-nounuselocal.test.ts
...dir/types-gen-nounuselocal/types-gen-nounuselocal.test.ts
+91
-0
No files found.
packages/next/src/server/lib/router-utils/typegen.ts
View file @
4efa10f0
...
@@ -22,10 +22,10 @@ function generateRouteTypes(routesManifest: RouteTypesManifest): string {
...
@@ -22,10 +22,10 @@ function generateRouteTypes(routesManifest: RouteTypesManifest): string {
routesManifest
.
appRouteHandlerRoutes
routesManifest
.
appRouteHandlerRoutes
).
sort
()
).
sort
()
if
(
appRouteHandlerRoutes
.
length
>
0
)
{
const
hasAppRouteHandlers
=
appRouteHandlerRoutes
.
length
>
0
if
(
hasAppRouteHandlers
)
{
result
+=
`type AppRouteHandlerRoutes =
${
appRouteHandlerRoutes
.
map
((
route
)
=>
JSON
.
stringify
(
route
)).
join
(
' | '
)}
\n`
result
+=
`type AppRouteHandlerRoutes =
${
appRouteHandlerRoutes
.
map
((
route
)
=>
JSON
.
stringify
(
route
)).
join
(
' | '
)}
\n`
}
else
{
result
+=
'type AppRouteHandlerRoutes = never
\
n'
}
}
// Generate PageRoutes union type
// Generate PageRoutes union type
...
@@ -60,8 +60,19 @@ function generateRouteTypes(routesManifest: RouteTypesManifest): string {
...
@@ -60,8 +60,19 @@ function generateRouteTypes(routesManifest: RouteTypesManifest): string {
result
+=
'type RewriteRoutes = never
\
n'
result
+=
'type RewriteRoutes = never
\
n'
}
}
result
+=
// Only include AppRouteHandlerRoutes in Routes union if there are actual route handlers
'type Routes = AppRoutes | AppRouteHandlerRoutes | PageRoutes | LayoutRoutes | RedirectRoutes | RewriteRoutes
\
n'
const
routeUnionParts
=
[
'AppRoutes'
,
'PageRoutes'
,
'LayoutRoutes'
,
'RedirectRoutes'
,
'RewriteRoutes'
,
]
if
(
hasAppRouteHandlers
)
{
routeUnionParts
.
push
(
'AppRouteHandlerRoutes'
)
}
result
+=
`type Routes =
${
routeUnionParts
.
join
(
' | '
)}
\n`
return
result
return
result
}
}
...
@@ -427,15 +438,14 @@ export function generateValidatorFile(
...
@@ -427,15 +438,14 @@ export function generateValidatorFile(
routesManifest
.
filePathToRoute
routesManifest
.
filePathToRoute
)
)
return
`// This file is generated automatically by Next.js
const
hasAppRouteHandlers
=
// Do not edit this file manually
Object
.
keys
(
routesManifest
.
appRouteHandlerRoutes
).
length
>
0
// This file validates that all pages and layouts export the correct types
import type { AppRoutes, AppRouteHandlerRoutes, LayoutRoutes, ParamMap } from "./routes.js"
// Build type definitions based on what's actually used
import type { ResolvingMetadata, ResolvingViewport } from "next/dist/lib/metadata/types/metadata-interface.js"
let
typeDefinitions
=
''
import type { NextRequest } from 'next/server.js'
type AppPageConfig<Route extends AppRoutes = AppRoutes> = {
if
(
appPageValidations
)
{
typeDefinitions
+=
`type AppPageConfig<Route extends AppRoutes = AppRoutes> = {
default: React.ComponentType<{ params: Promise<ParamMap[Route]> } & any> | ((props: { params: Promise<ParamMap[Route]> } & any) => React.ReactNode | Promise<React.ReactNode> | never | void | Promise<void>)
default: React.ComponentType<{ params: Promise<ParamMap[Route]> } & any> | ((props: { params: Promise<ParamMap[Route]> } & any) => React.ReactNode | Promise<React.ReactNode> | never | void | Promise<void>)
generateStaticParams?: (props: { params: ParamMap[Route] }) => Promise<any[]> | any[]
generateStaticParams?: (props: { params: ParamMap[Route] }) => Promise<any[]> | any[]
generateMetadata?: (
generateMetadata?: (
...
@@ -450,7 +460,11 @@ type AppPageConfig<Route extends AppRoutes = AppRoutes> = {
...
@@ -450,7 +460,11 @@ type AppPageConfig<Route extends AppRoutes = AppRoutes> = {
viewport?: any
viewport?: any
}
}
type PagesPageConfig = {
`
}
if
(
pagesRouterPageValidations
)
{
typeDefinitions
+=
`type PagesPageConfig = {
default: React.ComponentType<any> | ((props: any) => React.ReactNode | Promise<React.ReactNode> | never | void)
default: React.ComponentType<any> | ((props: any) => React.ReactNode | Promise<React.ReactNode> | never | void)
getStaticProps?: (context: any) => Promise<any> | any
getStaticProps?: (context: any) => Promise<any> | any
getStaticPaths?: (context: any) => Promise<any> | any
getStaticPaths?: (context: any) => Promise<any> | any
...
@@ -468,7 +482,11 @@ type PagesPageConfig = {
...
@@ -468,7 +482,11 @@ type PagesPageConfig = {
}
}
}
}
type LayoutConfig<Route extends LayoutRoutes = LayoutRoutes> = {
`
}
if
(
layoutValidations
)
{
typeDefinitions
+=
`type LayoutConfig<Route extends LayoutRoutes = LayoutRoutes> = {
default: React.ComponentType<LayoutProps<Route>> | ((props: LayoutProps<Route>) => React.ReactNode | Promise<React.ReactNode> | never | void | Promise<void>)
default: React.ComponentType<LayoutProps<Route>> | ((props: LayoutProps<Route>) => React.ReactNode | Promise<React.ReactNode> | never | void | Promise<void>)
generateStaticParams?: (props: { params: ParamMap[Route] }) => Promise<any[]> | any[]
generateStaticParams?: (props: { params: ParamMap[Route] }) => Promise<any[]> | any[]
generateMetadata?: (
generateMetadata?: (
...
@@ -483,7 +501,11 @@ type LayoutConfig<Route extends LayoutRoutes = LayoutRoutes> = {
...
@@ -483,7 +501,11 @@ type LayoutConfig<Route extends LayoutRoutes = LayoutRoutes> = {
viewport?: any
viewport?: any
}
}
type RouteHandlerConfig<Route extends AppRouteHandlerRoutes = AppRouteHandlerRoutes> = {
`
}
if
(
appRouteHandlerValidations
)
{
typeDefinitions
+=
`type RouteHandlerConfig<Route extends AppRouteHandlerRoutes = AppRouteHandlerRoutes> = {
GET?: (request: NextRequest, context: { params: Promise<ParamMap[Route]> }) => Promise<Response> | Response | Promise<void> | void
GET?: (request: NextRequest, context: { params: Promise<ParamMap[Route]> }) => Promise<Response> | Response | Promise<void> | void
POST?: (request: NextRequest, context: { params: Promise<ParamMap[Route]> }) => Promise<Response> | Response | Promise<void> | void
POST?: (request: NextRequest, context: { params: Promise<ParamMap[Route]> }) => Promise<Response> | Response | Promise<void> | void
PUT?: (request: NextRequest, context: { params: Promise<ParamMap[Route]> }) => Promise<Response> | Response | Promise<void> | void
PUT?: (request: NextRequest, context: { params: Promise<ParamMap[Route]> }) => Promise<Response> | Response | Promise<void> | void
...
@@ -493,7 +515,11 @@ type RouteHandlerConfig<Route extends AppRouteHandlerRoutes = AppRouteHandlerRou
...
@@ -493,7 +515,11 @@ type RouteHandlerConfig<Route extends AppRouteHandlerRoutes = AppRouteHandlerRou
OPTIONS?: (request: NextRequest, context: { params: Promise<ParamMap[Route]> }) => Promise<Response> | Response | Promise<void> | void
OPTIONS?: (request: NextRequest, context: { params: Promise<ParamMap[Route]> }) => Promise<Response> | Response | Promise<void> | void
}
}
type ApiRouteConfig = {
`
}
if
(
pagesApiRouteValidations
)
{
typeDefinitions
+=
`type ApiRouteConfig = {
default: (req: any, res: any) => Promise<void> | void | Promise<Response> | Response
default: (req: any, res: any) => Promise<void> | void | Promise<Response> | Response
config?: {
config?: {
api?: {
api?: {
...
@@ -506,6 +532,32 @@ type ApiRouteConfig = {
...
@@ -506,6 +532,32 @@ type ApiRouteConfig = {
}
}
}
}
`
}
// Build import statement based on what's actually needed
const
routeImports
=
[
'AppRoutes'
,
'LayoutRoutes'
,
'ParamMap'
]
if
(
hasAppRouteHandlers
)
{
routeImports
.
push
(
'AppRouteHandlerRoutes'
)
}
const
routeImportStatement
=
routeImports
.
length
>
0
?
`import type {
${
routeImports
.
join
(
', '
)}
} from "./routes.js"`
:
''
const
nextRequestImport
=
hasAppRouteHandlers
?
"import type { NextRequest } from 'next/server.js'
\n
"
:
''
return
`// This file is generated automatically by Next.js
// Do not edit this file manually
// This file validates that all pages and layouts export the correct types
${
routeImportStatement
}
import type { ResolvingMetadata, ResolvingViewport } from "next/dist/lib/metadata/types/metadata-interface.js"
${
nextRequestImport
}
${
typeDefinitions
}
${
appPageValidations
}
${
appPageValidations
}
${
appRouteHandlerValidations
}
${
appRouteHandlerValidations
}
...
@@ -525,6 +577,42 @@ export function generateRouteTypesFile(
...
@@ -525,6 +577,42 @@ export function generateRouteTypesFile(
const
paramTypes
=
generateParamTypes
(
routesManifest
)
const
paramTypes
=
generateParamTypes
(
routesManifest
)
const
layoutSlotMap
=
generateLayoutSlotMap
(
routesManifest
)
const
layoutSlotMap
=
generateLayoutSlotMap
(
routesManifest
)
const
hasAppRouteHandlers
=
Object
.
keys
(
routesManifest
.
appRouteHandlerRoutes
).
length
>
0
// Build export statement based on what's actually generated
const
routeExports
=
[
'AppRoutes'
,
'PageRoutes'
,
'LayoutRoutes'
,
'RedirectRoutes'
,
'RewriteRoutes'
,
'ParamMap'
,
]
if
(
hasAppRouteHandlers
)
{
routeExports
.
push
(
'AppRouteHandlerRoutes'
)
}
const
exportStatement
=
`export type {
${
routeExports
.
join
(
', '
)}
}`
const
routeContextInterface
=
hasAppRouteHandlers
?
`
/**
* Context for Next.js App Router route handlers
* @example
* \`\`\`tsx
* export async function GET(request: NextRequest, context: RouteContext<'/api/users/[id]'>) {
* const { id } = await context.params
* return Response.json({ id })
* }
* \`\`\`
*/
interface RouteContext<AppRouteHandlerRoute extends AppRouteHandlerRoutes> {
params: Promise<ParamMap[AppRouteHandlerRoute]>
}`
:
''
return
`// This file is generated automatically by Next.js
return
`// This file is generated automatically by Next.js
// Do not edit this file manually
// Do not edit this file manually
...
@@ -536,7 +624,7 @@ export type ParamsOf<Route extends Routes> = ParamMap[Route]
...
@@ -536,7 +624,7 @@ export type ParamsOf<Route extends Routes> = ParamMap[Route]
${
layoutSlotMap
}
${
layoutSlotMap
}
export type { AppRoutes, AppRouteHandlerRoutes, PageRoutes, LayoutRoutes, RedirectRoutes, RewriteRoutes, ParamMap
}
${
exportStatement
}
declare global {
declare global {
/**
/**
...
@@ -568,21 +656,7 @@ declare global {
...
@@ -568,21 +656,7 @@ declare global {
children: React.ReactNode
children: React.ReactNode
} & {
} & {
[K in LayoutSlotMap[LayoutRoute]]: React.ReactNode
[K in LayoutSlotMap[LayoutRoute]]: React.ReactNode
}
}
${
routeContextInterface
}
/**
* Context for Next.js App Router route handlers
* @example
* \`\`\`tsx
* export async function GET(request: NextRequest, context: RouteContext<'/api/users/[id]'>) {
* const { id } = await context.params
* return Response.json({ id })
* }
* \`\`\`
*/
interface RouteContext<AppRouteHandlerRoute extends AppRouteHandlerRoutes> {
params: Promise<ParamMap[AppRouteHandlerRoute]>
}
}
}
`
`
}
}
test/e2e/app-dir/typed-routes/typed-routes.test.ts
View file @
4efa10f0
...
@@ -7,7 +7,7 @@ type PageRoutes = "/about" | "/users/[id]"
...
@@ -7,7 +7,7 @@ type PageRoutes = "/about" | "/users/[id]"
type LayoutRoutes = "/" | "/dashboard"
type LayoutRoutes = "/" | "/dashboard"
type RedirectRoutes = "/blog/[category]/[[...slug]]" | "/project/[slug]"
type RedirectRoutes = "/blog/[category]/[[...slug]]" | "/project/[slug]"
type RewriteRoutes = "/api-legacy/[version]/[[...endpoint]]" | "/docs-old/[...path]"
type RewriteRoutes = "/api-legacy/[version]/[[...endpoint]]" | "/docs-old/[...path]"
type Routes = AppRoutes |
AppRouteHandlerRoutes | PageRoutes | LayoutRoutes | RedirectRoutes | Rewrite
Routes
type Routes = AppRoutes |
PageRoutes | LayoutRoutes | RedirectRoutes | RewriteRoutes | AppRouteHandler
Routes
`
`
describe
(
'typed-routes'
,
()
=>
{
describe
(
'typed-routes'
,
()
=>
{
...
...
test/production/app-dir/types-gen-nounuselocal/.gitignore
0 → 100644
View file @
4efa10f0
!tsconfig.json
\ No newline at end of file
test/production/app-dir/types-gen-nounuselocal/app/layout.tsx
0 → 100644
View file @
4efa10f0
import
{
ReactNode
}
from
'react'
export
default
function
Root
({
children
}:
{
children
:
ReactNode
})
{
return
(
<
html
>
<
body
>
{
children
}
</
body
>
</
html
>
)
}
test/production/app-dir/types-gen-nounuselocal/app/page.tsx
0 → 100644
View file @
4efa10f0
export
default
function
Page
()
{
return
<
p
>
hello world
</
p
>
}
test/production/app-dir/types-gen-nounuselocal/next.config.js
0 → 100644
View file @
4efa10f0
/**
* @type {import('next').NextConfig}
*/
const
nextConfig
=
{}
module
.
exports
=
nextConfig
test/production/app-dir/types-gen-nounuselocal/tsconfig.json
0 → 100644
View file @
4efa10f0
{
"compilerOptions"
:
{
"target"
:
"ES2017"
,
"lib"
:
[
"dom"
,
"dom.iterable"
,
"esnext"
],
"allowJs"
:
true
,
"skipLibCheck"
:
true
,
"strict"
:
true
,
"noEmit"
:
true
,
"esModuleInterop"
:
true
,
"module"
:
"esnext"
,
"moduleResolution"
:
"bundler"
,
"resolveJsonModule"
:
true
,
"isolatedModules"
:
true
,
"jsx"
:
"preserve"
,
"incremental"
:
true
,
"noUnusedLocals"
:
true
,
"plugins"
:
[
{
"name"
:
"next"
}
],
"paths"
:
{
"@/*"
:
[
"./*"
]
}
},
"include"
:
[
"next-env.d.ts"
,
"**/*.ts"
,
"**/*.tsx"
,
".next/types/**/*.ts"
],
"exclude"
:
[
"node_modules"
,
"**/*.test.ts"
,
"**/*.test.tsx"
]
}
test/production/app-dir/types-gen-nounuselocal/types-gen-nounuselocal.test.ts
0 → 100644
View file @
4efa10f0
import
fsp
from
'fs/promises'
import
path
from
'path'
import
{
nextTestSetup
}
from
'e2e-utils'
describe
(
'types-gen-nounuselocal'
,
()
=>
{
const
{
next
,
skipped
}
=
nextTestSetup
({
files
:
__dirname
,
skipDeployment
:
true
,
})
if
(
skipped
)
{
return
}
it
(
'should build successfully'
,
async
()
=>
{
const
$
=
await
next
.
render$
(
'/'
)
expect
(
$
(
'p'
).
text
()).
toBe
(
'hello world'
)
})
it
(
'should generate route types successfully'
,
async
()
=>
{
const
routeTypes
=
await
fsp
.
readFile
(
path
.
join
(
next
.
testDir
,
'.next'
,
'types'
,
'routes.d.ts'
),
'utf-8'
)
expect
(
routeTypes
).
not
.
toContain
(
'AppRouteHandlerRoutes'
)
expect
(
routeTypes
).
not
.
toContain
(
'PagesPageConfig'
)
expect
(
routeTypes
).
not
.
toContain
(
'ApiRouteConfig'
)
expect
(
routeTypes
).
toMatchInlineSnapshot
(
`
"// This file is generated automatically by Next.js
// Do not edit this file manually
type AppRoutes = "/"
type PageRoutes = never
type LayoutRoutes = "/"
type RedirectRoutes = never
type RewriteRoutes = never
type Routes = AppRoutes | PageRoutes | LayoutRoutes | RedirectRoutes | RewriteRoutes
interface ParamMap {
"/": {}
}
export type ParamsOf<Route extends Routes> = ParamMap[Route]
interface LayoutSlotMap {
"/": never
}
export type { AppRoutes, PageRoutes, LayoutRoutes, RedirectRoutes, RewriteRoutes, ParamMap }
declare global {
/**
* Props for Next.js App Router page components
* @example
* \`\`\`tsx
* export default function Page(props: PageProps<'/blog/[slug]'>) {
* const { slug } = await props.params
* return <div>Blog post: {slug}</div>
* }
* \`\`\`
*/
interface PageProps<AppRoute extends AppRoutes> {
params: Promise<ParamMap[AppRoute]>
searchParams: Promise<Record<string, string | string[] | undefined>>
}
/**
* Props for Next.js App Router layout components
* @example
* \`\`\`tsx
* export default function Layout(props: LayoutProps<'/dashboard'>) {
* return <div>{props.children}</div>
* }
* \`\`\`
*/
type LayoutProps<LayoutRoute extends LayoutRoutes> = {
params: Promise<ParamMap[LayoutRoute]>
children: React.ReactNode
} & {
[K in LayoutSlotMap[LayoutRoute]]: React.ReactNode
}
}
"
`
)
})
})
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment