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

Avoid deprecated TS node10 moduleResolution defaults (#91847)

TypeScript 6 treats `moduleResolution: "node"` as deprecated (`node10`)
and can fail builds with `TS5107`.

This update keeps Next.js tsconfig defaults compatible with modern
TypeScript by preferring `moduleResolution: "bundler"` for modern module
modes, while preserving `"node"` for `commonjs`/`amd` configs where
`bundler` is invalid.

Also updates the related tests/snapshots to match the new defaults.
parent 7dd1fcfc
import { bold, cyan } from '../picocolors'
import os from 'os'
import path from 'path'
import semver from 'next/dist/compiled/semver'
import { FatalError } from '../fatal-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}`
}
export async function getTypeScriptConfiguration(
typescript: typeof import('typescript'),
tsConfigPath: string,
......@@ -28,6 +54,66 @@ export async function getTypeScriptConfiguration(
}
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 originalPaths = configToParse.compilerOptions?.paths
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, '*')]
}
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(
configToParse,
......
......@@ -68,7 +68,7 @@ describe('writeConfigurationDefaults()', () => {
"esnext",
],
"module": "esnext",
"moduleResolution": "node",
"moduleResolution": "bundler",
"noEmit": true,
"plugins": [
{
......@@ -113,7 +113,7 @@ describe('writeConfigurationDefaults()', () => {
- module was set to esnext (for dynamic import() support)
- 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)
- isolatedModules was set to true (requirement for SWC / Babel)
- jsx was set to react-jsx (next.js uses the React automatic runtime)
......@@ -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', () => {
let tsConfigBasePath: string
let nextAppTypes: string
......
......@@ -33,9 +33,18 @@ function getDesiredCompilerOptions(
// ModuleResolutionKind
const moduleResolutionKindBundler = 'bundler'
const moduleResolutionKindNode10 = 'node10'
const moduleResolutionKindNode16 = 'node16'
const moduleResolutionKindNodeNext = 'nodenext'
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
const jsxEmitReactJSX = 'react-jsx'
......@@ -89,21 +98,29 @@ function getDesiredCompilerOptions(
reason: 'requirement for SWC / babel',
},
moduleResolution: {
// In TypeScript 5.0, `NodeJs` has renamed to `Node10`
parsedValue: moduleResolutionKindBundler,
parsedValue: preferBundlerResolution
? moduleResolutionKindBundler
: moduleResolutionKindNode,
// All of these values work:
parsedValues: [
moduleResolutionKindNode10,
moduleResolutionKindNodeJs,
// only newer TypeScript versions have this field, it
// will be filtered for new versions of TypeScript
moduleResolutionKindNode12,
moduleKindNode16,
moduleKindNodeNext,
moduleResolutionKindBundler,
].filter((val) => typeof val !== 'undefined'),
value: 'node',
reason: 'to match webpack resolution',
parsedValues: preferBundlerResolution
? [
moduleResolutionKindNode16,
moduleResolutionKindNodeNext,
moduleResolutionKindBundler,
]
: [
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: {
value: true,
......@@ -161,9 +178,12 @@ export function getRequiredConfiguration(
import('typescript').ModuleResolutionKind
> = {
bundler: typescript.ModuleResolutionKind.Bundler,
node10: typescript.ModuleResolutionKind.Node10,
node16: typescript.ModuleResolutionKind.Node16,
nodenext: typescript.ModuleResolutionKind.NodeNext,
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
} else if (optionKey === 'jsx' && typeof value === 'string') {
......
......@@ -39,7 +39,7 @@ describe('correct tsconfig.json defaults', () => {
expect(next.cliOutput).not.toContain('moduleResolution')
expect(tsconfig.compilerOptions).toEqual(
expect.objectContaining({ moduleResolution: 'node' })
expect.objectContaining({ moduleResolution: 'bundler' })
)
} finally {
await next.stop()
......@@ -57,7 +57,7 @@ describe('correct tsconfig.json defaults', () => {
const tsconfig = JSON.parse(await next.readFile('tsconfig.json'))
expect(tsconfig.compilerOptions).toEqual(
expect.objectContaining({ moduleResolution: 'node' })
expect.objectContaining({ moduleResolution: 'bundler' })
)
expect(next.cliOutput).not.toContain('moduleResolution')
} finally {
......
// @ts-expect-error no types defined
import { Hello } from '@monorepo/adapter-next'
export default function Page() {
......
......@@ -5,6 +5,8 @@ describe('twoslash', () => {
files: __dirname,
dependencies: {
twoslash: '0.3.4',
'twoslash-protocol': '0.3.4',
typescript: '5.9.2',
},
})
......
......@@ -17,6 +17,8 @@ if (!(globalThis as any).isNextStart) {
files: __dirname,
dependencies: {
twoslash: '0.3.4',
'twoslash-protocol': '0.3.4',
typescript: '5.9.2',
},
skipStart: true,
})
......
......@@ -45,7 +45,7 @@ const strictRouteTypes =
"incremental": true,
"module": "esnext",
"esModuleInterop": true,
"moduleResolution": "node",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "react-jsx",
......@@ -85,7 +85,7 @@ const strictRouteTypes =
"incremental": true,
"module": "esnext",
"esModuleInterop": true,
"moduleResolution": "node",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "react-jsx",
......@@ -144,7 +144,7 @@ const strictRouteTypes =
"incremental": true,
"module": "esnext",
"esModuleInterop": true,
"moduleResolution": "node",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "react-jsx",
......@@ -184,7 +184,7 @@ const strictRouteTypes =
"incremental": true,
"module": "esnext",
"esModuleInterop": true,
"moduleResolution": "node",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "react-jsx",
......@@ -260,7 +260,7 @@ const strictRouteTypes =
"strict": false,
"noEmit": true,
"incremental": true,
"moduleResolution": "node",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "react-jsx",
......@@ -308,7 +308,7 @@ const strictRouteTypes =
"strict": false,
"noEmit": true,
"incremental": true,
"moduleResolution": "node",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "react-jsx",
......@@ -463,7 +463,7 @@ const strictRouteTypes =
"strict": false,
"noEmit": true,
"incremental": true,
"moduleResolution": "node",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "react-jsx",
......@@ -503,7 +503,7 @@ const strictRouteTypes =
"strict": false,
"noEmit": true,
"incremental": true,
"moduleResolution": "node",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "react-jsx",
......@@ -760,7 +760,7 @@ const strictRouteTypes =
"incremental": true,
"module": "esnext",
"esModuleInterop": true,
"moduleResolution": "node",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "react-jsx",
......@@ -800,7 +800,7 @@ const strictRouteTypes =
"incremental": true,
"module": "esnext",
"esModuleInterop": true,
"moduleResolution": "node",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "react-jsx",
......@@ -961,7 +961,7 @@ const strictRouteTypes =
"incremental": true,
"module": "esnext",
"esModuleInterop": true,
"moduleResolution": "node",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"jsx": "react-jsx",
"plugins": [
......@@ -1001,7 +1001,7 @@ const strictRouteTypes =
"incremental": true,
"module": "esnext",
"esModuleInterop": true,
"moduleResolution": "node",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"jsx": "react-jsx",
"plugins": [
......@@ -1050,7 +1050,7 @@ const strictRouteTypes =
"incremental": true,
"module": "esnext",
"esModuleInterop": true,
"moduleResolution": "node",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"jsx": "react-jsx",
"plugins": [
......
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