ec25b4742b
This adds handling for auto-detecting TypeScript being added to a project and installing the necessary dependencies instead of printing the command and requiring the user run the command. We have been testing the auto install handling for a while now with the `next lint` command and it has worked out pretty well. This also adds HMR handling for `jsconfig.json`/`tsconfig.json` in development so if the `baseURL` or `paths` configs are modified it doesn't require a dev server restart for the updates to be picked up. This also corrects our required dependencies detection as previously an incorrect `paths: []` value was being passed to `require.resolve` causing it to fail in specific situations. Closes: https://github.com/vercel/next.js/issues/36201 ### `next build` before https://user-images.githubusercontent.com/22380829/186039578-75f8c128-a13d-4e07-b5da-13bf186ee011.mp4 ### `next build` after https://user-images.githubusercontent.com/22380829/186039662-57af22a4-da5c-4ede-94ea-96541a032cca.mp4 ### `next dev` automatic setup and HMR handling https://user-images.githubusercontent.com/22380829/186039678-d78469ef-d00b-4ee6-8163-a4706394a7b4.mp4 ## Bug - [x] Related issues linked using `fixes #number` - [x] Integration tests added - [x] Errors have helpful link attached, see `contributing.md`
115 lines
3 KiB
TypeScript
115 lines
3 KiB
TypeScript
/* eslint-disable import/no-extraneous-dependencies */
|
|
import chalk from 'chalk'
|
|
import spawn from 'cross-spawn'
|
|
import type { PackageManager } from './get-pkg-manager'
|
|
|
|
interface InstallArgs {
|
|
/**
|
|
* Indicate whether to install packages using npm, pnpm or Yarn.
|
|
*/
|
|
packageManager: PackageManager
|
|
/**
|
|
* Indicate whether there is an active Internet connection.
|
|
*/
|
|
isOnline: boolean
|
|
/**
|
|
* Indicate whether the given dependencies are devDependencies.
|
|
*/
|
|
devDependencies?: boolean
|
|
}
|
|
|
|
/**
|
|
* Spawn a package manager installation with either Yarn or NPM.
|
|
*
|
|
* @returns A Promise that resolves once the installation is finished.
|
|
*/
|
|
export function install(
|
|
root: string,
|
|
dependencies: string[] | null,
|
|
{ packageManager, isOnline, devDependencies }: InstallArgs
|
|
): Promise<void> {
|
|
/**
|
|
* (p)npm-specific command-line flags.
|
|
*/
|
|
const npmFlags: string[] = []
|
|
/**
|
|
* Yarn-specific command-line flags.
|
|
*/
|
|
const yarnFlags: string[] = []
|
|
/**
|
|
* Return a Promise that resolves once the installation is finished.
|
|
*/
|
|
return new Promise((resolve, reject) => {
|
|
let args: string[]
|
|
let command = packageManager
|
|
const useYarn = packageManager === 'yarn'
|
|
|
|
if (dependencies && dependencies.length) {
|
|
/**
|
|
* If there are dependencies, run a variation of `{packageManager} add`.
|
|
*/
|
|
if (useYarn) {
|
|
/**
|
|
* Call `yarn add --exact (--offline)? (-D)? ...`.
|
|
*/
|
|
args = ['add', '--exact']
|
|
if (!isOnline) args.push('--offline')
|
|
args.push('--cwd', root)
|
|
if (devDependencies) args.push('--dev')
|
|
args.push(...dependencies)
|
|
} else {
|
|
/**
|
|
* Call `(p)npm install [--save|--save-dev] ...`.
|
|
*/
|
|
args = ['install', '--save-exact']
|
|
args.push(devDependencies ? '--save-dev' : '--save')
|
|
args.push(...dependencies)
|
|
}
|
|
} else {
|
|
/**
|
|
* If there are no dependencies, run a variation of `{packageManager}
|
|
* install`.
|
|
*/
|
|
args = ['install']
|
|
if (!isOnline) {
|
|
console.log(chalk.yellow('You appear to be offline.'))
|
|
if (useYarn) {
|
|
console.log(chalk.yellow('Falling back to the local Yarn cache.'))
|
|
console.log()
|
|
args.push('--offline')
|
|
} else {
|
|
console.log()
|
|
}
|
|
}
|
|
}
|
|
/**
|
|
* Add any package manager-specific flags.
|
|
*/
|
|
if (useYarn) {
|
|
args.push(...yarnFlags)
|
|
} else {
|
|
args.push(...npmFlags)
|
|
}
|
|
/**
|
|
* Spawn the installation process.
|
|
*/
|
|
const child = spawn(command, args, {
|
|
stdio: 'inherit',
|
|
env: {
|
|
...process.env,
|
|
ADBLOCK: '1',
|
|
// we set NODE_ENV to development as pnpm skips dev
|
|
// dependencies when production
|
|
NODE_ENV: 'development',
|
|
DISABLE_OPENCOLLECTIVE: '1',
|
|
},
|
|
})
|
|
child.on('close', (code) => {
|
|
if (code !== 0) {
|
|
reject({ command: `${command} ${args.join(' ')}` })
|
|
return
|
|
}
|
|
resolve()
|
|
})
|
|
})
|
|
}
|