Unverified Commit ec129dce authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

codemod: override and install (#71318)

Co-authored-by: 's avatareps1lon <sebastian.silbermann@vercel.com>
parent 4e055447
...@@ -5,7 +5,11 @@ import compareVersions from 'semver/functions/compare' ...@@ -5,7 +5,11 @@ import compareVersions from 'semver/functions/compare'
import { execSync } from 'child_process' import { execSync } from 'child_process'
import path from 'path' import path from 'path'
import pc from 'picocolors' import pc from 'picocolors'
import { getPkgManager, installPackages } from '../lib/handle-package' import {
getPkgManager,
addPackageDependency,
runInstallation,
} from '../lib/handle-package'
import { runTransform } from './transform' import { runTransform } from './transform'
import { onCancel, TRANSFORMER_INQUIRER_CHOICES } from '../lib/utils' import { onCancel, TRANSFORMER_INQUIRER_CHOICES } from '../lib/utils'
import { BadInput } from './shared' import { BadInput } from './shared'
...@@ -172,8 +176,13 @@ export async function runUpgrade( ...@@ -172,8 +176,13 @@ export async function runUpgrade(
fs.writeFileSync(appPackageJsonPath, JSON.stringify(appPackageJson, null, 2)) fs.writeFileSync(appPackageJsonPath, JSON.stringify(appPackageJson, null, 2))
const dependenciesToInstall = [] const dependenciesToInstall: [string, string][] = []
const devDependenciesToInstall = [] const devDependenciesToInstall: [string, string][] = []
const allDependencies = {
...appPackageJson.dependencies,
...appPackageJson.devDependencies,
}
const versionMapping: Record<string, { version: string; required: boolean }> = const versionMapping: Record<string, { version: string; required: boolean }> =
{ {
...@@ -188,13 +197,22 @@ export async function runUpgrade( ...@@ -188,13 +197,22 @@ export async function runUpgrade(
targetReactVersion.startsWith('19.0.0-beta') || targetReactVersion.startsWith('19.0.0-beta') ||
targetReactVersion.startsWith('19.0.0-rc') targetReactVersion.startsWith('19.0.0-rc')
) { ) {
versionMapping['@types/react'] = { const [targetReactTypesVersion, targetReactDOMTypesVersion] =
version: `npm:types-react@rc`, await Promise.all([
required: false, loadHighestNPMVersionMatching(`types-react@rc`),
loadHighestNPMVersionMatching(`types-react-dom@rc`),
])
if (allDependencies['@types/react']) {
versionMapping['@types/react'] = {
version: `npm:types-react@${targetReactTypesVersion}`,
required: false,
}
} }
versionMapping['@types/react-dom'] = { if (allDependencies['@types/react-dom']) {
version: `npm:types-react-dom@rc`, versionMapping['@types/react-dom'] = {
required: false, version: `npm:types-react-dom@${targetReactDOMTypesVersion}`,
required: false,
}
} }
} else { } else {
const [targetReactTypesVersion, targetReactDOMTypesVersion] = const [targetReactTypesVersion, targetReactDOMTypesVersion] =
...@@ -207,23 +225,40 @@ export async function runUpgrade( ...@@ -207,23 +225,40 @@ export async function runUpgrade(
), ),
]) ])
versionMapping['@types/react'] = { if (allDependencies['@types/react']) {
version: targetReactTypesVersion, versionMapping['@types/react'] = {
required: false, version: targetReactTypesVersion,
required: false,
}
} }
versionMapping['@types/react-dom'] = { if (allDependencies['@types/react-dom']) {
version: targetReactDOMTypesVersion, versionMapping['@types/react-dom'] = {
required: false, version: targetReactDOMTypesVersion,
required: false,
}
} }
} }
// Even though we only need those if we alias `@types/react` to types-react,
// we still do it out of safety due to https://github.com/microsoft/DefinitelyTyped-tools/issues/433.
const overrides: Record<string, string> = {}
if (allDependencies['@types/react']) {
overrides['@types/react'] = versionMapping['@types/react'].version
}
if (allDependencies['@types/react-dom']) {
overrides['@types/react-dom'] = versionMapping['@types/react-dom'].version
}
writeOverridesField(appPackageJson, packageManager, overrides)
for (const [packageName, { version, required }] of Object.entries( for (const [packageName, { version, required }] of Object.entries(
versionMapping versionMapping
)) { )) {
if (appPackageJson.devDependencies?.[packageName]) { if (appPackageJson.devDependencies?.[packageName]) {
devDependenciesToInstall.push(`${packageName}@${version}`) devDependenciesToInstall.push([packageName, version])
} else if (required || appPackageJson.dependencies?.[packageName]) { } else if (required || appPackageJson.dependencies?.[packageName]) {
dependenciesToInstall.push(`${packageName}@${version}`) dependenciesToInstall.push([packageName, version])
} }
} }
...@@ -231,15 +266,16 @@ export async function runUpgrade( ...@@ -231,15 +266,16 @@ export async function runUpgrade(
`Upgrading your project to ${pc.blue('Next.js ' + targetNextVersion)}...\n` `Upgrading your project to ${pc.blue('Next.js ' + targetNextVersion)}...\n`
) )
installPackages(dependenciesToInstall, { for (const [dep, version] of dependenciesToInstall) {
packageManager, addPackageDependency(appPackageJson, dep, version, false)
silent: !verbose, }
}) for (const [dep, version] of devDependenciesToInstall) {
installPackages(devDependenciesToInstall, { addPackageDependency(appPackageJson, dep, version, true)
packageManager, }
silent: !verbose,
dev: true, fs.writeFileSync(appPackageJsonPath, JSON.stringify(appPackageJson, null, 2))
})
runInstallation(packageManager)
for (const codemod of codemods) { for (const codemod of codemods) {
await runTransform(codemod, process.cwd(), { force: true, verbose }) await runTransform(codemod, process.cwd(), { force: true, verbose })
...@@ -461,3 +497,42 @@ async function suggestReactTypesCodemods(): Promise<boolean> { ...@@ -461,3 +497,42 @@ async function suggestReactTypesCodemods(): Promise<boolean> {
return runReactTypesCodemod return runReactTypesCodemod
} }
function writeOverridesField(
packageJson: any,
packageManager: PackageManager,
overrides: Record<string, string>
) {
if (packageManager === 'bun' || packageManager === 'npm') {
if (!packageJson.overrides) {
packageJson.overrides = {}
}
for (const [key, value] of Object.entries(overrides)) {
packageJson.overrides[key] = value
}
} else if (packageManager === 'pnpm') {
// pnpm supports pnpm.overrides and pnpm.resolutions
if (packageJson.resolutions) {
for (const [key, value] of Object.entries(overrides)) {
packageJson.resolutions[key] = value
}
} else {
if (!packageJson.pnpm) {
packageJson.pnpm = {}
}
if (!packageJson.pnpm.overrides) {
packageJson.pnpm.overrides = {}
}
for (const [key, value] of Object.entries(overrides)) {
packageJson.pnpm.overrides[key] = value
}
}
} else if (packageManager === 'yarn') {
if (!packageJson.resolutions) {
packageJson.resolutions = {}
}
for (const [key, value] of Object.entries(overrides)) {
packageJson.resolutions[key] = value
}
}
}
...@@ -106,3 +106,31 @@ export function installPackages( ...@@ -106,3 +106,31 @@ export function installPackages(
) )
} }
} }
export function runInstallation(packageManager: PackageManager) {
try {
execa.sync(packageManager, ['install'], {
stdio: 'inherit',
shell: true,
})
} catch (error) {
throw new Error('Failed to install dependencies', { cause: error })
}
}
export function addPackageDependency(
packageJson: Record<string, any>,
name: string,
version: string,
dev: boolean
): void {
if (dev) {
packageJson.devDependencies = packageJson.devDependencies || {}
} else {
packageJson.dependencies = packageJson.dependencies || {}
}
const deps = dev ? packageJson.devDependencies : packageJson.dependencies
deps[name] = version
}
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