Unverified Commit edcf19ae authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Backport: TypeScript v6 deprecations for baseUrl and moduleResolution (#92130)

backports: https://github.com/vercel/next.js/pull/91855
backports: https://github.com/vercel/next.js/pull/91847
parent eee3f524
...@@ -219,6 +219,7 @@ import { ...@@ -219,6 +219,7 @@ import {
writeRouteTypesManifest, writeRouteTypesManifest,
writeValidatorFile, writeValidatorFile,
} from '../server/lib/router-utils/route-types-utils' } from '../server/lib/router-utils/route-types-utils'
import { writeCacheLifeTypes } from '../server/lib/router-utils/cache-life-type-utils'
import { Lockfile } from './lockfile' import { Lockfile } from './lockfile'
import { import {
buildPrefetchSegmentDataRoute, buildPrefetchSegmentDataRoute,
...@@ -1391,6 +1392,11 @@ export default async function build( ...@@ -1391,6 +1392,11 @@ export default async function build(
.traceAsyncFn(async () => { .traceAsyncFn(async () => {
const routeTypesFilePath = path.join(distDir, 'types', 'routes.d.ts') const routeTypesFilePath = path.join(distDir, 'types', 'routes.d.ts')
const validatorFilePath = path.join(distDir, 'types', 'validator.ts') const validatorFilePath = path.join(distDir, 'types', 'validator.ts')
const cacheLifeFilePath = path.join(
distDir,
'types',
'cache-life.d.ts'
)
await mkdir(path.dirname(routeTypesFilePath), { recursive: true }) await mkdir(path.dirname(routeTypesFilePath), { recursive: true })
const routeTypesManifest = await createRouteTypesManifest({ const routeTypesManifest = await createRouteTypesManifest({
...@@ -1416,6 +1422,7 @@ export default async function build( ...@@ -1416,6 +1422,7 @@ export default async function build(
validatorFilePath, validatorFilePath,
Boolean(config.experimental.strictRouteTypes) Boolean(config.experimental.strictRouteTypes)
) )
writeCacheLifeTypes(config.cacheLife, cacheLifeFilePath)
}) })
// Turbopack already handles conflicting app and page routes. // Turbopack already handles conflicting app and page routes.
......
import { bold, cyan } from '../picocolors' import { bold, cyan } from '../picocolors'
import os from 'os' import os from 'os'
import path from 'path' import path from 'path'
import semver from 'next/dist/compiled/semver'
import { FatalError } from '../fatal-error' import { FatalError } from '../fatal-error'
import isError from '../is-error' import isError from '../is-error'
function resolvePathAliasTarget(baseUrl: string, target: string): string {
if (
path.isAbsolute(target) ||
target.startsWith('./') ||
target.startsWith('../')
) {
return target
}
if (baseUrl === '.' || baseUrl === './') {
return `./${target}`
}
const resolvedTarget = path.join(baseUrl, target)
if (
path.isAbsolute(resolvedTarget) ||
resolvedTarget.startsWith('./') ||
resolvedTarget.startsWith('../')
) {
return resolvedTarget
}
return `./${resolvedTarget}`
}
function rewritePathAliasesWithoutBaseUrl(
baseUrl: string,
originalPaths: unknown
): Record<string, unknown> {
const rewrittenPaths: Record<string, unknown> =
originalPaths && typeof originalPaths === 'object'
? Object.fromEntries(
Object.entries(originalPaths).map(([key, values]) => [
key,
Array.isArray(values)
? values.map((value) =>
typeof value === 'string'
? resolvePathAliasTarget(baseUrl, value)
: value
)
: values,
])
)
: {
'*': [resolvePathAliasTarget(baseUrl, '*')],
}
if (!Object.prototype.hasOwnProperty.call(rewrittenPaths, '*')) {
rewrittenPaths['*'] = [resolvePathAliasTarget(baseUrl, '*')]
}
return rewrittenPaths
}
function getNormalizedBaseUrlForPaths(
baseUrl: string,
tsConfigPath: string
): string {
const tsConfigDir = path.resolve(path.dirname(tsConfigPath))
const absoluteBaseUrl = path.isAbsolute(baseUrl)
? baseUrl
: baseUrl.startsWith('./') || baseUrl.startsWith('../')
? path.resolve(tsConfigDir, baseUrl)
: path.resolve(baseUrl)
const relativeBaseUrl = path.relative(tsConfigDir, absoluteBaseUrl)
return relativeBaseUrl || '.'
}
export async function getTypeScriptConfiguration( export async function getTypeScriptConfiguration(
typescript: typeof import('typescript'), typescript: typeof import('typescript'),
tsConfigPath: string, tsConfigPath: string,
...@@ -28,6 +98,49 @@ export async function getTypeScriptConfiguration( ...@@ -28,6 +98,49 @@ export async function getTypeScriptConfiguration(
} }
let configToParse: any = config let configToParse: any = config
if (semver.gte(typescript.version, '6.0.0')) {
const target = configToParse.compilerOptions?.target
if (
typeof target === 'string' &&
(target.toLowerCase() === 'es3' || target.toLowerCase() === 'es5')
) {
const { target: _target, ...restCompilerOptions } =
configToParse.compilerOptions ?? {}
// TypeScript 6 deprecates ES3/ES5 targets. Rewrite deprecated
// targets in-memory to keep typechecking working without requiring
// `ignoreDeprecations`.
configToParse = {
...configToParse,
compilerOptions: {
...restCompilerOptions,
target: 'es2015',
},
}
}
const baseUrl = configToParse.compilerOptions?.baseUrl
const hasBaseUrl = typeof baseUrl === 'string' && baseUrl.length > 0
if (hasBaseUrl) {
const rewrittenPaths = rewritePathAliasesWithoutBaseUrl(
baseUrl,
configToParse.compilerOptions?.paths
)
const { baseUrl: _baseUrl, ...restCompilerOptions } =
configToParse.compilerOptions ?? {}
// TypeScript 6 deprecates `baseUrl`; rewrite aliases to explicit
// relative paths so path mapping still works without this option.
configToParse = {
...configToParse,
compilerOptions: {
...restCompilerOptions,
paths: rewrittenPaths,
},
}
}
}
const result = typescript.parseJsonConfigFileContent( const result = typescript.parseJsonConfigFileContent(
configToParse, configToParse,
...@@ -44,6 +157,25 @@ export async function getTypeScriptConfiguration( ...@@ -44,6 +157,25 @@ export async function getTypeScriptConfiguration(
path.dirname(tsConfigPath) path.dirname(tsConfigPath)
) )
if (semver.gte(typescript.version, '6.0.0')) {
const parsedBaseUrl = result.options.baseUrl
if (typeof parsedBaseUrl === 'string' && parsedBaseUrl.length > 0) {
const normalizedBaseUrl = getNormalizedBaseUrlForPaths(
parsedBaseUrl,
tsConfigPath
)
// `baseUrl` can come from extended tsconfigs. Rewrite paths from the
// fully-resolved baseUrl and remove it so TS6 deprecation checks do not
// fail type checking.
result.options.paths = rewritePathAliasesWithoutBaseUrl(
normalizedBaseUrl,
result.options.paths
) as import('typescript').MapLike<string[]>
delete (result.options as { baseUrl?: unknown }).baseUrl
}
}
if (result.errors) { if (result.errors) {
result.errors = result.errors.filter( result.errors = result.errors.filter(
({ code }) => ({ code }) =>
......
...@@ -68,7 +68,7 @@ describe('writeConfigurationDefaults()', () => { ...@@ -68,7 +68,7 @@ describe('writeConfigurationDefaults()', () => {
"esnext", "esnext",
], ],
"module": "esnext", "module": "esnext",
"moduleResolution": "node", "moduleResolution": "bundler",
"noEmit": true, "noEmit": true,
"plugins": [ "plugins": [
{ {
...@@ -113,7 +113,7 @@ describe('writeConfigurationDefaults()', () => { ...@@ -113,7 +113,7 @@ describe('writeConfigurationDefaults()', () => {
- module was set to esnext (for dynamic import() support) - module was set to esnext (for dynamic import() support)
- esModuleInterop was set to true (requirement for SWC / babel) - esModuleInterop was set to true (requirement for SWC / babel)
- moduleResolution was set to node (to match webpack resolution) - moduleResolution was set to bundler (to match modern bundler resolution)
- resolveJsonModule was set to true (to match webpack resolution) - resolveJsonModule was set to true (to match webpack resolution)
- isolatedModules was set to true (requirement for SWC / Babel) - isolatedModules was set to true (requirement for SWC / Babel)
- jsx was set to react-jsx (next.js uses the React automatic runtime) - jsx was set to react-jsx (next.js uses the React automatic runtime)
...@@ -143,6 +143,31 @@ describe('writeConfigurationDefaults()', () => { ...@@ -143,6 +143,31 @@ describe('writeConfigurationDefaults()', () => {
) )
}) })
it('uses bundler moduleResolution for TypeScript 6+', async () => {
await writeFile(tsConfigPath, JSON.stringify({ compilerOptions: {} }), {
encoding: 'utf8',
})
await writeConfigurationDefaults(
'6.0.0',
tsConfigPath,
isFirstTimeSetup,
hasAppDir,
distDir,
hasPagesDir,
experimentalStrictRouteTypes
)
const tsConfig = JSON.parse(
await readFile(tsConfigPath, { encoding: 'utf8' })
)
expect(tsConfig.compilerOptions.moduleResolution).toBe('bundler')
expect(stripAnsi(consoleLogSpy.mock.calls.flat().join('\n'))).toContain(
'- moduleResolution was set to bundler (to match modern bundler resolution)'
)
})
describe('with tsconfig extends', () => { describe('with tsconfig extends', () => {
let tsConfigBasePath: string let tsConfigBasePath: string
let nextAppTypes: string let nextAppTypes: string
......
...@@ -33,9 +33,18 @@ function getDesiredCompilerOptions( ...@@ -33,9 +33,18 @@ function getDesiredCompilerOptions(
// ModuleResolutionKind // ModuleResolutionKind
const moduleResolutionKindBundler = 'bundler' const moduleResolutionKindBundler = 'bundler'
const moduleResolutionKindNode10 = 'node10' const moduleResolutionKindNode16 = 'node16'
const moduleResolutionKindNodeNext = 'nodenext'
const moduleResolutionKindNode12 = 'node12' const moduleResolutionKindNode12 = 'node12'
const moduleResolutionKindNodeJs = 'node' const moduleResolutionKindNode = 'node'
const configuredModule =
typeof userTsConfig?.compilerOptions?.module === 'string'
? userTsConfig.compilerOptions.module.toLowerCase()
: undefined
const preferBundlerResolution =
semver.gte(typescriptVersion, '5.0.0') &&
configuredModule !== moduleKindCommonJS &&
configuredModule !== moduleKindAMD
// Jsx // Jsx
const jsxEmitReactJSX = 'react-jsx' const jsxEmitReactJSX = 'react-jsx'
...@@ -89,21 +98,29 @@ function getDesiredCompilerOptions( ...@@ -89,21 +98,29 @@ function getDesiredCompilerOptions(
reason: 'requirement for SWC / babel', reason: 'requirement for SWC / babel',
}, },
moduleResolution: { moduleResolution: {
// In TypeScript 5.0, `NodeJs` has renamed to `Node10` parsedValue: preferBundlerResolution
parsedValue: moduleResolutionKindBundler, ? moduleResolutionKindBundler
: moduleResolutionKindNode,
// All of these values work: // All of these values work:
parsedValues: [ parsedValues: preferBundlerResolution
moduleResolutionKindNode10, ? [
moduleResolutionKindNodeJs, moduleResolutionKindNode16,
// only newer TypeScript versions have this field, it moduleResolutionKindNodeNext,
// will be filtered for new versions of TypeScript
moduleResolutionKindNode12,
moduleKindNode16,
moduleKindNodeNext,
moduleResolutionKindBundler, moduleResolutionKindBundler,
].filter((val) => typeof val !== 'undefined'), ]
value: 'node', : [
reason: 'to match webpack resolution', moduleResolutionKindNode,
// only older TypeScript versions have this field
moduleResolutionKindNode12,
moduleResolutionKindNode16,
moduleResolutionKindNodeNext,
],
value: preferBundlerResolution
? moduleResolutionKindBundler
: moduleResolutionKindNode,
reason: preferBundlerResolution
? 'to match modern bundler resolution'
: 'to match webpack resolution',
}, },
resolveJsonModule: { resolveJsonModule: {
value: true, value: true,
...@@ -161,9 +178,12 @@ export function getRequiredConfiguration( ...@@ -161,9 +178,12 @@ export function getRequiredConfiguration(
import('typescript').ModuleResolutionKind import('typescript').ModuleResolutionKind
> = { > = {
bundler: typescript.ModuleResolutionKind.Bundler, bundler: typescript.ModuleResolutionKind.Bundler,
node10: typescript.ModuleResolutionKind.Node10, node16: typescript.ModuleResolutionKind.Node16,
nodenext: typescript.ModuleResolutionKind.NodeNext,
node12: (typescript.ModuleResolutionKind as any).Node12, node12: (typescript.ModuleResolutionKind as any).Node12,
node: typescript.ModuleResolutionKind.NodeJs, node:
(typescript.ModuleResolutionKind as any).Node10 ??
typescript.ModuleResolutionKind.NodeJs,
} }
res[optionKey] = moduleResolutionMap[value.toLowerCase()] ?? value res[optionKey] = moduleResolutionMap[value.toLowerCase()] ?? value
} else if (optionKey === 'jsx' && typeof value === 'string') { } else if (optionKey === 'jsx' && typeof value === 'string') {
......
...@@ -39,7 +39,7 @@ describe('correct tsconfig.json defaults', () => { ...@@ -39,7 +39,7 @@ describe('correct tsconfig.json defaults', () => {
expect(next.cliOutput).not.toContain('moduleResolution') expect(next.cliOutput).not.toContain('moduleResolution')
expect(tsconfig.compilerOptions).toEqual( expect(tsconfig.compilerOptions).toEqual(
expect.objectContaining({ moduleResolution: 'node' }) expect.objectContaining({ moduleResolution: 'bundler' })
) )
} finally { } finally {
await next.stop() await next.stop()
...@@ -57,7 +57,7 @@ describe('correct tsconfig.json defaults', () => { ...@@ -57,7 +57,7 @@ describe('correct tsconfig.json defaults', () => {
const tsconfig = JSON.parse(await next.readFile('tsconfig.json')) const tsconfig = JSON.parse(await next.readFile('tsconfig.json'))
expect(tsconfig.compilerOptions).toEqual( expect(tsconfig.compilerOptions).toEqual(
expect.objectContaining({ moduleResolution: 'node' }) expect.objectContaining({ moduleResolution: 'bundler' })
) )
expect(next.cliOutput).not.toContain('moduleResolution') expect(next.cliOutput).not.toContain('moduleResolution')
} finally { } finally {
......
// @ts-expect-error no types defined
import { Hello } from '@monorepo/adapter-next' import { Hello } from '@monorepo/adapter-next'
export default function Page() { export default function Page() {
......
...@@ -5,6 +5,8 @@ describe('twoslash', () => { ...@@ -5,6 +5,8 @@ describe('twoslash', () => {
files: __dirname, files: __dirname,
dependencies: { dependencies: {
twoslash: '0.3.4', twoslash: '0.3.4',
'twoslash-protocol': '0.3.4',
typescript: '5.9.2',
}, },
}) })
......
...@@ -17,6 +17,8 @@ if (!(globalThis as any).isNextStart) { ...@@ -17,6 +17,8 @@ if (!(globalThis as any).isNextStart) {
files: __dirname, files: __dirname,
dependencies: { dependencies: {
twoslash: '0.3.4', twoslash: '0.3.4',
'twoslash-protocol': '0.3.4',
typescript: '5.9.2',
}, },
skipStart: true, skipStart: true,
}) })
......
...@@ -45,7 +45,7 @@ const strictRouteTypes = ...@@ -45,7 +45,7 @@ const strictRouteTypes =
"incremental": true, "incremental": true,
"module": "esnext", "module": "esnext",
"esModuleInterop": true, "esModuleInterop": true,
"moduleResolution": "node", "moduleResolution": "bundler",
"resolveJsonModule": true, "resolveJsonModule": true,
"isolatedModules": true, "isolatedModules": true,
"jsx": "react-jsx", "jsx": "react-jsx",
...@@ -85,7 +85,7 @@ const strictRouteTypes = ...@@ -85,7 +85,7 @@ const strictRouteTypes =
"incremental": true, "incremental": true,
"module": "esnext", "module": "esnext",
"esModuleInterop": true, "esModuleInterop": true,
"moduleResolution": "node", "moduleResolution": "bundler",
"resolveJsonModule": true, "resolveJsonModule": true,
"isolatedModules": true, "isolatedModules": true,
"jsx": "react-jsx", "jsx": "react-jsx",
...@@ -144,7 +144,7 @@ const strictRouteTypes = ...@@ -144,7 +144,7 @@ const strictRouteTypes =
"incremental": true, "incremental": true,
"module": "esnext", "module": "esnext",
"esModuleInterop": true, "esModuleInterop": true,
"moduleResolution": "node", "moduleResolution": "bundler",
"resolveJsonModule": true, "resolveJsonModule": true,
"isolatedModules": true, "isolatedModules": true,
"jsx": "react-jsx", "jsx": "react-jsx",
...@@ -184,7 +184,7 @@ const strictRouteTypes = ...@@ -184,7 +184,7 @@ const strictRouteTypes =
"incremental": true, "incremental": true,
"module": "esnext", "module": "esnext",
"esModuleInterop": true, "esModuleInterop": true,
"moduleResolution": "node", "moduleResolution": "bundler",
"resolveJsonModule": true, "resolveJsonModule": true,
"isolatedModules": true, "isolatedModules": true,
"jsx": "react-jsx", "jsx": "react-jsx",
...@@ -260,7 +260,7 @@ const strictRouteTypes = ...@@ -260,7 +260,7 @@ const strictRouteTypes =
"strict": false, "strict": false,
"noEmit": true, "noEmit": true,
"incremental": true, "incremental": true,
"moduleResolution": "node", "moduleResolution": "bundler",
"resolveJsonModule": true, "resolveJsonModule": true,
"isolatedModules": true, "isolatedModules": true,
"jsx": "react-jsx", "jsx": "react-jsx",
...@@ -308,7 +308,7 @@ const strictRouteTypes = ...@@ -308,7 +308,7 @@ const strictRouteTypes =
"strict": false, "strict": false,
"noEmit": true, "noEmit": true,
"incremental": true, "incremental": true,
"moduleResolution": "node", "moduleResolution": "bundler",
"resolveJsonModule": true, "resolveJsonModule": true,
"isolatedModules": true, "isolatedModules": true,
"jsx": "react-jsx", "jsx": "react-jsx",
...@@ -463,7 +463,7 @@ const strictRouteTypes = ...@@ -463,7 +463,7 @@ const strictRouteTypes =
"strict": false, "strict": false,
"noEmit": true, "noEmit": true,
"incremental": true, "incremental": true,
"moduleResolution": "node", "moduleResolution": "bundler",
"resolveJsonModule": true, "resolveJsonModule": true,
"isolatedModules": true, "isolatedModules": true,
"jsx": "react-jsx", "jsx": "react-jsx",
...@@ -503,7 +503,7 @@ const strictRouteTypes = ...@@ -503,7 +503,7 @@ const strictRouteTypes =
"strict": false, "strict": false,
"noEmit": true, "noEmit": true,
"incremental": true, "incremental": true,
"moduleResolution": "node", "moduleResolution": "bundler",
"resolveJsonModule": true, "resolveJsonModule": true,
"isolatedModules": true, "isolatedModules": true,
"jsx": "react-jsx", "jsx": "react-jsx",
...@@ -760,7 +760,7 @@ const strictRouteTypes = ...@@ -760,7 +760,7 @@ const strictRouteTypes =
"incremental": true, "incremental": true,
"module": "esnext", "module": "esnext",
"esModuleInterop": true, "esModuleInterop": true,
"moduleResolution": "node", "moduleResolution": "bundler",
"resolveJsonModule": true, "resolveJsonModule": true,
"isolatedModules": true, "isolatedModules": true,
"jsx": "react-jsx", "jsx": "react-jsx",
...@@ -800,7 +800,7 @@ const strictRouteTypes = ...@@ -800,7 +800,7 @@ const strictRouteTypes =
"incremental": true, "incremental": true,
"module": "esnext", "module": "esnext",
"esModuleInterop": true, "esModuleInterop": true,
"moduleResolution": "node", "moduleResolution": "bundler",
"resolveJsonModule": true, "resolveJsonModule": true,
"isolatedModules": true, "isolatedModules": true,
"jsx": "react-jsx", "jsx": "react-jsx",
...@@ -961,7 +961,7 @@ const strictRouteTypes = ...@@ -961,7 +961,7 @@ const strictRouteTypes =
"incremental": true, "incremental": true,
"module": "esnext", "module": "esnext",
"esModuleInterop": true, "esModuleInterop": true,
"moduleResolution": "node", "moduleResolution": "bundler",
"resolveJsonModule": true, "resolveJsonModule": true,
"jsx": "react-jsx", "jsx": "react-jsx",
"plugins": [ "plugins": [
...@@ -1001,7 +1001,7 @@ const strictRouteTypes = ...@@ -1001,7 +1001,7 @@ const strictRouteTypes =
"incremental": true, "incremental": true,
"module": "esnext", "module": "esnext",
"esModuleInterop": true, "esModuleInterop": true,
"moduleResolution": "node", "moduleResolution": "bundler",
"resolveJsonModule": true, "resolveJsonModule": true,
"jsx": "react-jsx", "jsx": "react-jsx",
"plugins": [ "plugins": [
...@@ -1050,7 +1050,7 @@ const strictRouteTypes = ...@@ -1050,7 +1050,7 @@ const strictRouteTypes =
"incremental": true, "incremental": true,
"module": "esnext", "module": "esnext",
"esModuleInterop": true, "esModuleInterop": true,
"moduleResolution": "node", "moduleResolution": "bundler",
"resolveJsonModule": true, "resolveJsonModule": true,
"jsx": "react-jsx", "jsx": "react-jsx",
"plugins": [ "plugins": [
......
...@@ -31,6 +31,12 @@ describe('types-gen-nounuselocal', () => { ...@@ -31,6 +31,12 @@ describe('types-gen-nounuselocal', () => {
expect(routeTypes).not.toContain('ApiRouteConfig') expect(routeTypes).not.toContain('ApiRouteConfig')
if (strictRouteTypes) { if (strictRouteTypes) {
const cacheLifeTypes = await fsp.readFile(
path.join(next.testDir, '.next', 'types', 'cache-life.d.ts'),
'utf-8'
)
expect(cacheLifeTypes).toContain("declare module 'next/cache'")
expect(routeTypes).toMatchInlineSnapshot(` expect(routeTypes).toMatchInlineSnapshot(`
"// This file is generated automatically by Next.js with experimental.strictRouteTypes "// This file is generated automatically by Next.js with experimental.strictRouteTypes
// Do not edit this file manually // Do not edit this file manually
......
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