d51fef5fc9
If a user does not specify `--example` when using create-next-app then just spin up the default template and only prompt them for the name of their project. if a user does specify `--example` (with no string after it) then show them the example picker. Closes #13960
182 lines
4.8 KiB
JavaScript
182 lines
4.8 KiB
JavaScript
#!/usr/bin/env node
|
|
/* eslint-disable import/no-extraneous-dependencies */
|
|
import chalk from 'chalk'
|
|
import Commander from 'commander'
|
|
import path from 'path'
|
|
import prompts from 'prompts'
|
|
import checkForUpdate from 'update-check'
|
|
import { createApp, DownloadError } from './create-app'
|
|
import { shouldUseYarn } from './helpers/should-use-yarn'
|
|
import { validateNpmName } from './helpers/validate-pkg'
|
|
import packageJson from './package.json'
|
|
|
|
let projectPath: string = ''
|
|
|
|
const program = new Commander.Command(packageJson.name)
|
|
.version(packageJson.version)
|
|
.arguments('<project-directory>')
|
|
.usage(`${chalk.green('<project-directory>')} [options]`)
|
|
.action((name) => {
|
|
projectPath = name
|
|
})
|
|
.option('--use-npm')
|
|
.option(
|
|
'-e, --example [name]|[github-url]',
|
|
`
|
|
|
|
An example to bootstrap the app with. You can use an example name
|
|
from the official Next.js repo or a GitHub URL. The URL can use
|
|
any branch and/or subdirectory
|
|
`
|
|
)
|
|
.option(
|
|
'--example-path <path-to-example>',
|
|
`
|
|
|
|
In a rare case, your GitHub URL might contain a branch name with
|
|
a slash (e.g. bug/fix-1) and the path to the example (e.g. foo/bar).
|
|
In this case, you must specify the path to the example separately:
|
|
--example-path foo/bar
|
|
`
|
|
)
|
|
.allowUnknownOption()
|
|
.parse(process.argv)
|
|
|
|
async function run(): Promise<void> {
|
|
if (typeof projectPath === 'string') {
|
|
projectPath = projectPath.trim()
|
|
}
|
|
|
|
if (!projectPath) {
|
|
const res = await prompts({
|
|
type: 'text',
|
|
name: 'path',
|
|
message: 'What is your project named?',
|
|
initial: 'my-app',
|
|
validate: (name) => {
|
|
const validation = validateNpmName(path.basename(path.resolve(name)))
|
|
if (validation.valid) {
|
|
return true
|
|
}
|
|
return 'Invalid project name: ' + validation.problems![0]
|
|
},
|
|
})
|
|
|
|
if (typeof res.path === 'string') {
|
|
projectPath = res.path.trim()
|
|
}
|
|
}
|
|
|
|
if (!projectPath) {
|
|
console.log()
|
|
console.log('Please specify the project directory:')
|
|
console.log(
|
|
` ${chalk.cyan(program.name())} ${chalk.green('<project-directory>')}`
|
|
)
|
|
console.log()
|
|
console.log('For example:')
|
|
console.log(` ${chalk.cyan(program.name())} ${chalk.green('my-next-app')}`)
|
|
console.log()
|
|
console.log(
|
|
`Run ${chalk.cyan(`${program.name()} --help`)} to see all options.`
|
|
)
|
|
process.exit(1)
|
|
}
|
|
|
|
const resolvedProjectPath = path.resolve(projectPath)
|
|
const projectName = path.basename(resolvedProjectPath)
|
|
|
|
const { valid, problems } = validateNpmName(projectName)
|
|
if (!valid) {
|
|
console.error(
|
|
`Could not create a project called ${chalk.red(
|
|
`"${projectName}"`
|
|
)} because of npm naming restrictions:`
|
|
)
|
|
|
|
problems!.forEach((p) => console.error(` ${chalk.red.bold('*')} ${p}`))
|
|
process.exit(1)
|
|
}
|
|
|
|
if (program.example === true) {
|
|
console.error(
|
|
'Please provide an example name or url, otherwise remove the example option.'
|
|
)
|
|
process.exit(1)
|
|
return
|
|
}
|
|
|
|
const example = typeof program.example === 'string' && program.example.trim()
|
|
try {
|
|
await createApp({
|
|
appPath: resolvedProjectPath,
|
|
useNpm: !!program.useNpm,
|
|
example: example && example !== 'default' ? example : undefined,
|
|
examplePath: program.examplePath,
|
|
})
|
|
} catch (reason) {
|
|
if (!(reason instanceof DownloadError)) {
|
|
throw reason
|
|
}
|
|
|
|
const res = await prompts({
|
|
type: 'confirm',
|
|
name: 'builtin',
|
|
message:
|
|
`Could not download "${example}" because of a connectivity issue between your machine and GitHub.\n` +
|
|
`Do you want to use the default template instead?`,
|
|
initial: true,
|
|
})
|
|
if (!res.builtin) {
|
|
throw reason
|
|
}
|
|
|
|
await createApp({ appPath: resolvedProjectPath, useNpm: !!program.useNpm })
|
|
}
|
|
}
|
|
|
|
const update = checkForUpdate(packageJson).catch(() => null)
|
|
|
|
async function notifyUpdate(): Promise<void> {
|
|
try {
|
|
const res = await update
|
|
if (res?.latest) {
|
|
const isYarn = shouldUseYarn()
|
|
|
|
console.log()
|
|
console.log(
|
|
chalk.yellow.bold('A new version of `create-next-app` is available!')
|
|
)
|
|
console.log(
|
|
'You can update by running: ' +
|
|
chalk.cyan(
|
|
isYarn
|
|
? 'yarn global add create-next-app'
|
|
: 'npm i -g create-next-app'
|
|
)
|
|
)
|
|
console.log()
|
|
}
|
|
process.exit()
|
|
} catch {
|
|
// ignore error
|
|
}
|
|
}
|
|
|
|
run()
|
|
.then(notifyUpdate)
|
|
.catch(async (reason) => {
|
|
console.log()
|
|
console.log('Aborting installation.')
|
|
if (reason.command) {
|
|
console.log(` ${chalk.cyan(reason.command)} has failed.`)
|
|
} else {
|
|
console.log(chalk.red('Unexpected error. Please report it as a bug:'))
|
|
console.log(reason)
|
|
}
|
|
console.log()
|
|
|
|
await notifyUpdate()
|
|
|
|
process.exit(1)
|
|
})
|