Unverified Commit 4efa10f0 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

[type] dynamic skip generating unused types (#82755)

parent a90827be
......@@ -22,10 +22,10 @@ function generateRouteTypes(routesManifest: RouteTypesManifest): string {
routesManifest.appRouteHandlerRoutes
).sort()
if (appRouteHandlerRoutes.length > 0) {
const hasAppRouteHandlers = appRouteHandlerRoutes.length > 0
if (hasAppRouteHandlers) {
result += `type AppRouteHandlerRoutes = ${appRouteHandlerRoutes.map((route) => JSON.stringify(route)).join(' | ')}\n`
} else {
result += 'type AppRouteHandlerRoutes = never\n'
}
// Generate PageRoutes union type
......@@ -60,8 +60,19 @@ function generateRouteTypes(routesManifest: RouteTypesManifest): string {
result += 'type RewriteRoutes = never\n'
}
result +=
'type Routes = AppRoutes | AppRouteHandlerRoutes | PageRoutes | LayoutRoutes | RedirectRoutes | RewriteRoutes\n'
// Only include AppRouteHandlerRoutes in Routes union if there are actual route handlers
const routeUnionParts = [
'AppRoutes',
'PageRoutes',
'LayoutRoutes',
'RedirectRoutes',
'RewriteRoutes',
]
if (hasAppRouteHandlers) {
routeUnionParts.push('AppRouteHandlerRoutes')
}
result += `type Routes = ${routeUnionParts.join(' | ')}\n`
return result
}
......@@ -427,15 +438,14 @@ export function generateValidatorFile(
routesManifest.filePathToRoute
)
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
const hasAppRouteHandlers =
Object.keys(routesManifest.appRouteHandlerRoutes).length > 0
import type { AppRoutes, AppRouteHandlerRoutes, LayoutRoutes, ParamMap } from "./routes.js"
import type { ResolvingMetadata, ResolvingViewport } from "next/dist/lib/metadata/types/metadata-interface.js"
import type { NextRequest } from 'next/server.js'
// Build type definitions based on what's actually used
let typeDefinitions = ''
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>)
generateStaticParams?: (props: { params: ParamMap[Route] }) => Promise<any[]> | any[]
generateMetadata?: (
......@@ -450,7 +460,11 @@ type AppPageConfig<Route extends AppRoutes = AppRoutes> = {
viewport?: any
}
type PagesPageConfig = {
`
}
if (pagesRouterPageValidations) {
typeDefinitions += `type PagesPageConfig = {
default: React.ComponentType<any> | ((props: any) => React.ReactNode | Promise<React.ReactNode> | never | void)
getStaticProps?: (context: any) => Promise<any> | any
getStaticPaths?: (context: any) => Promise<any> | any
......@@ -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>)
generateStaticParams?: (props: { params: ParamMap[Route] }) => Promise<any[]> | any[]
generateMetadata?: (
......@@ -483,7 +501,11 @@ type LayoutConfig<Route extends LayoutRoutes = LayoutRoutes> = {
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
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
......@@ -493,7 +515,11 @@ type RouteHandlerConfig<Route extends AppRouteHandlerRoutes = AppRouteHandlerRou
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
config?: {
api?: {
......@@ -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}
${appRouteHandlerValidations}
......@@ -525,6 +577,42 @@ export function generateRouteTypesFile(
const paramTypes = generateParamTypes(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
// Do not edit this file manually
......@@ -536,7 +624,7 @@ export type ParamsOf<Route extends Routes> = ParamMap[Route]
${layoutSlotMap}
export type { AppRoutes, AppRouteHandlerRoutes, PageRoutes, LayoutRoutes, RedirectRoutes, RewriteRoutes, ParamMap }
${exportStatement}
declare global {
/**
......@@ -568,21 +656,7 @@ declare global {
children: React.ReactNode
} & {
[K in LayoutSlotMap[LayoutRoute]]: React.ReactNode
}
/**
* 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]>
}
}${routeContextInterface}
}
`
}
......@@ -7,7 +7,7 @@ type PageRoutes = "/about" | "/users/[id]"
type LayoutRoutes = "/" | "/dashboard"
type RedirectRoutes = "/blog/[category]/[[...slug]]" | "/project/[slug]"
type RewriteRoutes = "/api-legacy/[version]/[[...endpoint]]" | "/docs-old/[...path]"
type Routes = AppRoutes | AppRouteHandlerRoutes | PageRoutes | LayoutRoutes | RedirectRoutes | RewriteRoutes
type Routes = AppRoutes | PageRoutes | LayoutRoutes | RedirectRoutes | RewriteRoutes | AppRouteHandlerRoutes
`
describe('typed-routes', () => {
......
!tsconfig.json
\ No newline at end of file
import { ReactNode } from 'react'
export default function Root({ children }: { children: ReactNode }) {
return (
<html>
<body>{children}</body>
</html>
)
}
export default function Page() {
return <p>hello world</p>
}
/**
* @type {import('next').NextConfig}
*/
const nextConfig = {}
module.exports = nextConfig
{
"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"]
}
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
}
}
"
`)
})
})
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment