Unverified Commit b983ce47 authored by Sebastian "Sebbie" Silbermann's avatar Sebastian "Sebbie" Silbermann Committed by GitHub

[strict-route-types] Typecheck pages router routes in absence of App Router (#87628)

parent b821f423
...@@ -20,6 +20,7 @@ import { hrtimeDurationToString } from './duration-to-string' ...@@ -20,6 +20,7 @@ import { hrtimeDurationToString } from './duration-to-string'
function verifyTypeScriptSetup( function verifyTypeScriptSetup(
dir: string, dir: string,
distDir: string, distDir: string,
strictRouteTypes: boolean,
typeCheckPreflight: boolean, typeCheckPreflight: boolean,
tsconfigPath: string | undefined, tsconfigPath: string | undefined,
disableStaticImages: boolean, disableStaticImages: boolean,
...@@ -50,6 +51,7 @@ function verifyTypeScriptSetup( ...@@ -50,6 +51,7 @@ function verifyTypeScriptSetup(
.verifyTypeScriptSetup({ .verifyTypeScriptSetup({
dir, dir,
distDir, distDir,
strictRouteTypes,
typeCheckPreflight, typeCheckPreflight,
tsconfigPath, tsconfigPath,
disableStaticImages, disableStaticImages,
...@@ -117,6 +119,7 @@ export async function startTypeChecking({ ...@@ -117,6 +119,7 @@ export async function startTypeChecking({
verifyTypeScriptSetup( verifyTypeScriptSetup(
dir, dir,
config.distDir, config.distDir,
Boolean(config.experimental.strictRouteTypes),
!ignoreTypeScriptErrors, !ignoreTypeScriptErrors,
config.typescript.tsconfigPath, config.typescript.tsconfigPath,
config.images.disableStaticImages, config.images.disableStaticImages,
......
...@@ -140,6 +140,7 @@ async function runPlaywright( ...@@ -140,6 +140,7 @@ async function runPlaywright(
const { version: typeScriptVersion } = await verifyTypeScriptSetup({ const { version: typeScriptVersion } = await verifyTypeScriptSetup({
dir: baseDir, dir: baseDir,
distDir: nextConfig.distDir, distDir: nextConfig.distDir,
strictRouteTypes: Boolean(nextConfig.experimental.strictRouteTypes),
typeCheckPreflight: false, typeCheckPreflight: false,
tsconfigPath: nextConfig.typescript.tsconfigPath, tsconfigPath: nextConfig.typescript.tsconfigPath,
disableStaticImages: nextConfig.images.disableStaticImages, disableStaticImages: nextConfig.images.disableStaticImages,
......
...@@ -54,9 +54,12 @@ const nextTypegen = async ( ...@@ -54,9 +54,12 @@ const nextTypegen = async (
const distDir = join(baseDir, nextConfig.distDir) const distDir = join(baseDir, nextConfig.distDir)
const { pagesDir, appDir } = findPagesDir(baseDir) const { pagesDir, appDir } = findPagesDir(baseDir)
const strictRouteTypes = Boolean(nextConfig.experimental.strictRouteTypes)
await verifyTypeScriptSetup({ await verifyTypeScriptSetup({
dir: baseDir, dir: baseDir,
distDir: nextConfig.distDir, distDir: nextConfig.distDir,
strictRouteTypes,
typeCheckPreflight: false, typeCheckPreflight: false,
tsconfigPath: nextConfig.typescript.tsconfigPath, tsconfigPath: nextConfig.typescript.tsconfigPath,
disableStaticImages: nextConfig.images.disableStaticImages, disableStaticImages: nextConfig.images.disableStaticImages,
...@@ -172,7 +175,7 @@ const nextTypegen = async ( ...@@ -172,7 +175,7 @@ const nextTypegen = async (
await writeValidatorFile( await writeValidatorFile(
routeTypesManifest, routeTypesManifest,
validatorFilePath, validatorFilePath,
Boolean(nextConfig.experimental.strictRouteTypes) strictRouteTypes
) )
// Generate cache-life types if cacheLife config exists // Generate cache-life types if cacheLife config exists
......
...@@ -16,6 +16,7 @@ describe('writeConfigurationDefaults()', () => { ...@@ -16,6 +16,7 @@ describe('writeConfigurationDefaults()', () => {
let isFirstTimeSetup: boolean let isFirstTimeSetup: boolean
let hasPagesDir: boolean let hasPagesDir: boolean
let isolatedDevBuild = true let isolatedDevBuild = true
let experimentalStrictRouteTypes = true
beforeEach(async () => { beforeEach(async () => {
consoleLogSpy = jest.spyOn(console, 'log').mockImplementation() consoleLogSpy = jest.spyOn(console, 'log').mockImplementation()
...@@ -47,7 +48,8 @@ describe('writeConfigurationDefaults()', () => { ...@@ -47,7 +48,8 @@ describe('writeConfigurationDefaults()', () => {
hasAppDir, hasAppDir,
distDir, distDir,
hasPagesDir, hasPagesDir,
isolatedDevBuild isolatedDevBuild,
experimentalStrictRouteTypes
) )
const tsConfig = JSON.parse( const tsConfig = JSON.parse(
...@@ -137,7 +139,8 @@ describe('writeConfigurationDefaults()', () => { ...@@ -137,7 +139,8 @@ describe('writeConfigurationDefaults()', () => {
hasAppDir, hasAppDir,
distDir, distDir,
hasPagesDir, hasPagesDir,
isolatedDevBuild isolatedDevBuild,
experimentalStrictRouteTypes
) )
expect(stripAnsi(consoleLogSpy.mock.calls.flat().join('\n'))).not.toMatch( expect(stripAnsi(consoleLogSpy.mock.calls.flat().join('\n'))).not.toMatch(
...@@ -170,7 +173,8 @@ describe('writeConfigurationDefaults()', () => { ...@@ -170,7 +173,8 @@ describe('writeConfigurationDefaults()', () => {
hasAppDir, hasAppDir,
distDir, distDir,
hasPagesDir, hasPagesDir,
isolatedDevBuild isolatedDevBuild,
experimentalStrictRouteTypes
) )
).resolves.not.toThrow() ).resolves.not.toThrow()
......
...@@ -190,7 +190,8 @@ export async function writeConfigurationDefaults( ...@@ -190,7 +190,8 @@ export async function writeConfigurationDefaults(
hasAppDir: boolean, hasAppDir: boolean,
distDir: string, distDir: string,
hasPagesDir: boolean, hasPagesDir: boolean,
isolatedDevBuild: boolean | undefined isolatedDevBuild: boolean | undefined,
strictRouteTypes: boolean
): Promise<void> { ): Promise<void> {
if (isFirstTimeSetup) { if (isFirstTimeSetup) {
writeFileSync(tsConfigPath, '{}' + os.EOL) writeFileSync(tsConfigPath, '{}' + os.EOL)
...@@ -276,27 +277,27 @@ export async function writeConfigurationDefaults( ...@@ -276,27 +277,27 @@ export async function writeConfigurationDefaults(
// Get type definition glob patterns using shared utility to ensure consistency // Get type definition glob patterns using shared utility to ensure consistency
// with other TypeScript infrastructure (e.g., runTypeCheck.ts) // with other TypeScript infrastructure (e.g., runTypeCheck.ts)
const nextAppTypes = getTypeDefinitionGlobPatterns( const nextTypes = getTypeDefinitionGlobPatterns(
distDir, distDir,
resolvedIsolatedDevBuild resolvedIsolatedDevBuild
) )
if (!('include' in userTsConfig)) { if (!('include' in userTsConfig)) {
userTsConfig.include = hasAppDir const defaultInclude =
? ['next-env.d.ts', ...nextAppTypes, '**/*.mts', '**/*.ts', '**/*.tsx'] hasAppDir || strictRouteTypes
? ['next-env.d.ts', ...nextTypes, '**/*.mts', '**/*.ts', '**/*.tsx']
: ['next-env.d.ts', '**/*.mts', '**/*.ts', '**/*.tsx'] : ['next-env.d.ts', '**/*.mts', '**/*.ts', '**/*.tsx']
userTsConfig.include = defaultInclude
suggestedActions.push( suggestedActions.push(
cyan('include') + cyan('include') +
' was set to ' + ' was set to [' +
bold( bold(defaultInclude.map((type) => `'${type}'`).join(', ')) +
hasAppDir ']'
? `['next-env.d.ts', ${nextAppTypes.map((type) => `'${type}'`).join(', ')}, '**/*.mts', '**/*.ts', '**/*.tsx']`
: `['next-env.d.ts', '**/*.mts', '**/*.ts', '**/*.tsx']`
)
) )
} else if (hasAppDir) { } else if (hasAppDir || strictRouteTypes) {
const missingFromResolved = [] const missingFromResolved = []
for (const type of nextAppTypes) { for (const type of nextTypes) {
if (!userTsConfig.include.includes(type)) { if (!userTsConfig.include.includes(type)) {
missingFromResolved.push(type) missingFromResolved.push(type)
} }
......
...@@ -37,6 +37,7 @@ export async function verifyTypeScriptSetup({ ...@@ -37,6 +37,7 @@ export async function verifyTypeScriptSetup({
dir, dir,
distDir, distDir,
cacheDir, cacheDir,
strictRouteTypes,
tsconfigPath, tsconfigPath,
typeCheckPreflight, typeCheckPreflight,
disableStaticImages, disableStaticImages,
...@@ -50,6 +51,7 @@ export async function verifyTypeScriptSetup({ ...@@ -50,6 +51,7 @@ export async function verifyTypeScriptSetup({
dir: string dir: string
distDir: string distDir: string
cacheDir?: string cacheDir?: string
strictRouteTypes: boolean
tsconfigPath: string | undefined tsconfigPath: string | undefined
typeCheckPreflight: boolean typeCheckPreflight: boolean
disableStaticImages: boolean disableStaticImages: boolean
...@@ -136,7 +138,8 @@ export async function verifyTypeScriptSetup({ ...@@ -136,7 +138,8 @@ export async function verifyTypeScriptSetup({
hasAppDir, hasAppDir,
distDir, distDir,
hasPagesDir, hasPagesDir,
isolatedDevBuild isolatedDevBuild,
strictRouteTypes
) )
// Write out the necessary `next-env.d.ts` file to correctly register // Write out the necessary `next-env.d.ts` file to correctly register
// Next.js' types: // Next.js' types:
......
...@@ -143,6 +143,7 @@ async function verifyTypeScript(opts: SetupOpts) { ...@@ -143,6 +143,7 @@ async function verifyTypeScript(opts: SetupOpts) {
const verifyResult = await verifyTypeScriptSetup({ const verifyResult = await verifyTypeScriptSetup({
dir: opts.dir, dir: opts.dir,
distDir: opts.nextConfig.distDir, distDir: opts.nextConfig.distDir,
strictRouteTypes: Boolean(opts.nextConfig.experimental.strictRouteTypes),
typeCheckPreflight: false, typeCheckPreflight: false,
tsconfigPath: opts.nextConfig.typescript.tsconfigPath, tsconfigPath: opts.nextConfig.typescript.tsconfigPath,
disableStaticImages: opts.nextConfig.images.disableStaticImages, disableStaticImages: opts.nextConfig.images.disableStaticImages,
......
...@@ -2,6 +2,9 @@ import { nextTestSetup } from 'e2e-utils' ...@@ -2,6 +2,9 @@ import { nextTestSetup } from 'e2e-utils'
import { retry } from 'next-test-utils' import { retry } from 'next-test-utils'
import stripAnsi from 'strip-ansi' import stripAnsi from 'strip-ansi'
const strictRouteTypes =
process.env.__NEXT_EXPERIMENTAL_STRICT_ROUTE_TYPES === 'true'
describe('tsconfig module: preserve', () => { describe('tsconfig module: preserve', () => {
const { next, skipped } = nextTestSetup({ const { next, skipped } = nextTestSetup({
files: { files: {
...@@ -37,6 +40,40 @@ describe('tsconfig module: preserve', () => { ...@@ -37,6 +40,40 @@ describe('tsconfig module: preserve', () => {
expect(output).not.toContain('esModuleInterop') expect(output).not.toContain('esModuleInterop')
expect(output).not.toContain('resolveJsonModule') expect(output).not.toContain('resolveJsonModule')
if (strictRouteTypes) {
expect(await next.readFile('tsconfig.json')).toMatchInlineSnapshot(`
"{
"compilerOptions": {
"module": "preserve",
"target": "ES2017",
"lib": [
"dom",
"dom.iterable",
"esnext"
],
"allowJs": true,
"skipLibCheck": true,
"strict": false,
"noEmit": true,
"incremental": true,
"isolatedModules": true,
"jsx": "react-jsx"
},
"include": [
"next-env.d.ts",
".next/types/**/*.ts",
".next/dev/types/**/*.ts",
"**/*.mts",
"**/*.ts",
"**/*.tsx"
],
"exclude": [
"node_modules"
]
}
"
`)
} else {
expect(await next.readFile('tsconfig.json')).toMatchInlineSnapshot(` expect(await next.readFile('tsconfig.json')).toMatchInlineSnapshot(`
"{ "{
"compilerOptions": { "compilerOptions": {
...@@ -67,5 +104,6 @@ describe('tsconfig module: preserve', () => { ...@@ -67,5 +104,6 @@ describe('tsconfig module: preserve', () => {
} }
" "
`) `)
}
}) })
}) })
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