3cb15a064b
<!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation or adding/fixing Examples - The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Closes NEXT- Fixes # --> --------- Co-authored-by: JJ Kasper <jj@jjsweb.site>
274 lines
7.1 KiB
TypeScript
274 lines
7.1 KiB
TypeScript
/* eslint-disable import/no-extraneous-dependencies */
|
|
import retry from 'async-retry'
|
|
import chalk from 'chalk'
|
|
import fs from 'fs'
|
|
import path from 'path'
|
|
import {
|
|
downloadAndExtractExample,
|
|
downloadAndExtractRepo,
|
|
getRepoInfo,
|
|
existsInRepo,
|
|
hasRepo,
|
|
RepoInfo,
|
|
} from './helpers/examples'
|
|
import { makeDir } from './helpers/make-dir'
|
|
import { tryGitInit } from './helpers/git'
|
|
import { install } from './helpers/install'
|
|
import { isFolderEmpty } from './helpers/is-folder-empty'
|
|
import { getOnline } from './helpers/is-online'
|
|
import { isWriteable } from './helpers/is-writeable'
|
|
import type { PackageManager } from './helpers/get-pkg-manager'
|
|
|
|
import {
|
|
getTemplateFile,
|
|
installTemplate,
|
|
TemplateMode,
|
|
TemplateType,
|
|
} from './templates'
|
|
|
|
export class DownloadError extends Error {}
|
|
|
|
export async function createApp({
|
|
appPath,
|
|
packageManager,
|
|
example,
|
|
examplePath,
|
|
typescript,
|
|
tailwind,
|
|
eslint,
|
|
appRouter,
|
|
srcDir,
|
|
importAlias,
|
|
}: {
|
|
appPath: string
|
|
packageManager: PackageManager
|
|
example?: string
|
|
examplePath?: string
|
|
typescript: boolean
|
|
tailwind: boolean
|
|
eslint: boolean
|
|
appRouter: boolean
|
|
srcDir: boolean
|
|
importAlias: string
|
|
}): Promise<void> {
|
|
let repoInfo: RepoInfo | undefined
|
|
const mode: TemplateMode = typescript ? 'ts' : 'js'
|
|
const template: TemplateType = appRouter
|
|
? tailwind
|
|
? 'app-tw'
|
|
: 'app'
|
|
: tailwind
|
|
? 'default-tw'
|
|
: 'default'
|
|
|
|
if (example) {
|
|
let repoUrl: URL | undefined
|
|
|
|
try {
|
|
repoUrl = new URL(example)
|
|
} catch (error: any) {
|
|
if (error.code !== 'ERR_INVALID_URL') {
|
|
console.error(error)
|
|
process.exit(1)
|
|
}
|
|
}
|
|
|
|
if (repoUrl) {
|
|
if (repoUrl.origin !== 'https://github.com') {
|
|
console.error(
|
|
`Invalid URL: ${chalk.red(
|
|
`"${example}"`
|
|
)}. Only GitHub repositories are supported. Please use a GitHub URL and try again.`
|
|
)
|
|
process.exit(1)
|
|
}
|
|
|
|
repoInfo = await getRepoInfo(repoUrl, examplePath)
|
|
|
|
if (!repoInfo) {
|
|
console.error(
|
|
`Found invalid GitHub URL: ${chalk.red(
|
|
`"${example}"`
|
|
)}. Please fix the URL and try again.`
|
|
)
|
|
process.exit(1)
|
|
}
|
|
|
|
const found = await hasRepo(repoInfo)
|
|
|
|
if (!found) {
|
|
console.error(
|
|
`Could not locate the repository for ${chalk.red(
|
|
`"${example}"`
|
|
)}. Please check that the repository exists and try again.`
|
|
)
|
|
process.exit(1)
|
|
}
|
|
} else if (example !== '__internal-testing-retry') {
|
|
const found = await existsInRepo(example)
|
|
|
|
if (!found) {
|
|
console.error(
|
|
`Could not locate an example named ${chalk.red(
|
|
`"${example}"`
|
|
)}. It could be due to the following:\n`,
|
|
`1. Your spelling of example ${chalk.red(
|
|
`"${example}"`
|
|
)} might be incorrect.\n`,
|
|
`2. You might not be connected to the internet or you are behind a proxy.`
|
|
)
|
|
process.exit(1)
|
|
}
|
|
}
|
|
}
|
|
|
|
const root = path.resolve(appPath)
|
|
|
|
if (!(await isWriteable(path.dirname(root)))) {
|
|
console.error(
|
|
'The application path is not writable, please check folder permissions and try again.'
|
|
)
|
|
console.error(
|
|
'It is likely you do not have write permissions for this folder.'
|
|
)
|
|
process.exit(1)
|
|
}
|
|
|
|
const appName = path.basename(root)
|
|
|
|
await makeDir(root)
|
|
if (!isFolderEmpty(root, appName)) {
|
|
process.exit(1)
|
|
}
|
|
|
|
const useYarn = packageManager === 'yarn'
|
|
const isOnline = !useYarn || (await getOnline())
|
|
const originalDirectory = process.cwd()
|
|
|
|
console.log(`Creating a new Next.js app in ${chalk.green(root)}.`)
|
|
console.log()
|
|
|
|
process.chdir(root)
|
|
|
|
const packageJsonPath = path.join(root, 'package.json')
|
|
let hasPackageJson = false
|
|
|
|
if (example) {
|
|
/**
|
|
* If an example repository is provided, clone it.
|
|
*/
|
|
try {
|
|
if (repoInfo) {
|
|
const repoInfo2 = repoInfo
|
|
console.log(
|
|
`Downloading files from repo ${chalk.cyan(
|
|
example
|
|
)}. This might take a moment.`
|
|
)
|
|
console.log()
|
|
await retry(() => downloadAndExtractRepo(root, repoInfo2), {
|
|
retries: 3,
|
|
})
|
|
} else {
|
|
console.log(
|
|
`Downloading files for example ${chalk.cyan(
|
|
example
|
|
)}. This might take a moment.`
|
|
)
|
|
console.log()
|
|
await retry(() => downloadAndExtractExample(root, example), {
|
|
retries: 3,
|
|
})
|
|
}
|
|
} catch (reason) {
|
|
function isErrorLike(err: unknown): err is { message: string } {
|
|
return (
|
|
typeof err === 'object' &&
|
|
err !== null &&
|
|
typeof (err as { message?: unknown }).message === 'string'
|
|
)
|
|
}
|
|
throw new DownloadError(
|
|
isErrorLike(reason) ? reason.message : reason + ''
|
|
)
|
|
}
|
|
// Copy `.gitignore` if the application did not provide one
|
|
const ignorePath = path.join(root, '.gitignore')
|
|
if (!fs.existsSync(ignorePath)) {
|
|
fs.copyFileSync(
|
|
getTemplateFile({ template, mode, file: 'gitignore' }),
|
|
ignorePath
|
|
)
|
|
}
|
|
|
|
// Copy `next-env.d.ts` to any example that is typescript
|
|
const tsconfigPath = path.join(root, 'tsconfig.json')
|
|
if (fs.existsSync(tsconfigPath)) {
|
|
fs.copyFileSync(
|
|
getTemplateFile({ template, mode: 'ts', file: 'next-env.d.ts' }),
|
|
path.join(root, 'next-env.d.ts')
|
|
)
|
|
}
|
|
|
|
hasPackageJson = fs.existsSync(packageJsonPath)
|
|
if (hasPackageJson) {
|
|
console.log('Installing packages. This might take a couple of minutes.')
|
|
console.log()
|
|
|
|
await install(root, null, { packageManager, isOnline })
|
|
console.log()
|
|
}
|
|
} else {
|
|
/**
|
|
* If an example repository is not provided for cloning, proceed
|
|
* by installing from a template.
|
|
*/
|
|
await installTemplate({
|
|
appName,
|
|
root,
|
|
template,
|
|
mode,
|
|
packageManager,
|
|
isOnline,
|
|
tailwind,
|
|
eslint,
|
|
srcDir,
|
|
importAlias,
|
|
})
|
|
}
|
|
|
|
if (tryGitInit(root)) {
|
|
console.log('Initialized a git repository.')
|
|
console.log()
|
|
}
|
|
|
|
let cdpath: string
|
|
if (path.join(originalDirectory, appName) === appPath) {
|
|
cdpath = appName
|
|
} else {
|
|
cdpath = appPath
|
|
}
|
|
|
|
console.log(`${chalk.green('Success!')} Created ${appName} at ${appPath}`)
|
|
|
|
if (hasPackageJson) {
|
|
console.log('Inside that directory, you can run several commands:')
|
|
console.log()
|
|
console.log(chalk.cyan(` ${packageManager} ${useYarn ? '' : 'run '}dev`))
|
|
console.log(' Starts the development server.')
|
|
console.log()
|
|
console.log(chalk.cyan(` ${packageManager} ${useYarn ? '' : 'run '}build`))
|
|
console.log(' Builds the app for production.')
|
|
console.log()
|
|
console.log(chalk.cyan(` ${packageManager} start`))
|
|
console.log(' Runs the built app in production mode.')
|
|
console.log()
|
|
console.log('We suggest that you begin by typing:')
|
|
console.log()
|
|
console.log(chalk.cyan(' cd'), cdpath)
|
|
console.log(
|
|
` ${chalk.cyan(`${packageManager} ${useYarn ? '' : 'run '}dev`)}`
|
|
)
|
|
}
|
|
console.log()
|
|
}
|