486040eff2
Makes it easier to detect why a network error occurred with the CLI or `next info`, based on https://github.com/vercel/next.js/issues/36344 ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have helpful link attached, see `contributing.md` ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [ ] Errors have helpful link attached, see `contributing.md` ## Documentation / Examples - [ ] Make sure the linting passes by running `yarn lint`
112 lines
3 KiB
JavaScript
Executable file
112 lines
3 KiB
JavaScript
Executable file
#!/usr/bin/env node
|
|
import os from 'os'
|
|
import childProcess from 'child_process'
|
|
|
|
import chalk from 'next/dist/compiled/chalk'
|
|
import arg from 'next/dist/compiled/arg/index.js'
|
|
import fetch from 'next/dist/compiled/node-fetch'
|
|
import { printAndExit } from '../server/lib/utils'
|
|
import { cliCommand } from '../bin/next'
|
|
import isError from '../lib/is-error'
|
|
|
|
const nextInfo: cliCommand = async (argv) => {
|
|
const validArgs: arg.Spec = {
|
|
// Types
|
|
'--help': Boolean,
|
|
// Aliases
|
|
'-h': '--help',
|
|
}
|
|
let args: arg.Result<arg.Spec>
|
|
try {
|
|
args = arg(validArgs, { argv })
|
|
} catch (error) {
|
|
if (isError(error) && error.code === 'ARG_UNKNOWN_OPTION') {
|
|
return printAndExit(error.message, 1)
|
|
}
|
|
throw error
|
|
}
|
|
|
|
if (args['--help']) {
|
|
console.log(
|
|
`
|
|
Description
|
|
Prints relevant details about the current system which can be used to report Next.js bugs
|
|
|
|
Usage
|
|
$ next info
|
|
|
|
Learn more: ${chalk.cyan(
|
|
'https://nextjs.org/docs/api-reference/cli#info'
|
|
)}`
|
|
)
|
|
return
|
|
}
|
|
|
|
const installedRelease = getPackageVersion('next')
|
|
|
|
console.log(`
|
|
Operating System:
|
|
Platform: ${os.platform()}
|
|
Arch: ${os.arch()}
|
|
Version: ${os.version()}
|
|
Binaries:
|
|
Node: ${process.versions.node}
|
|
npm: ${getBinaryVersion('npm')}
|
|
Yarn: ${getBinaryVersion('yarn')}
|
|
pnpm: ${getBinaryVersion('pnpm')}
|
|
Relevant packages:
|
|
next: ${installedRelease}
|
|
react: ${getPackageVersion('react')}
|
|
react-dom: ${getPackageVersion('react-dom')}
|
|
`)
|
|
|
|
try {
|
|
const res = await fetch(
|
|
'https://api.github.com/repos/vercel/next.js/releases'
|
|
)
|
|
const releases = await res.json()
|
|
const newestRelease = releases[0].tag_name.replace(/^v/, '')
|
|
|
|
if (installedRelease !== newestRelease) {
|
|
console.warn(
|
|
`${chalk.yellow(
|
|
chalk.bold('warn')
|
|
)} - Latest canary version not detected, detected: "${installedRelease}", newest: "${newestRelease}".
|
|
Please try the latest canary version (\`npm install next@canary\`) to confirm the issue still exists before creating a new issue.
|
|
Read more - https://nextjs.org/docs/messages/opening-an-issue`
|
|
)
|
|
}
|
|
} catch (e) {
|
|
console.warn(
|
|
`${chalk.yellow(
|
|
chalk.bold('warn')
|
|
)} - Failed to fetch latest canary version. (Reason: ${
|
|
(e as Error).message
|
|
}.)
|
|
Detected "${installedRelease}". Visit https://github.com/vercel/next.js/releases.
|
|
Make sure to try the latest canary version (eg.: \`npm install next@canary\`) to confirm the issue still exists before creating a new issue.
|
|
Read more - https://nextjs.org/docs/messages/opening-an-issue`
|
|
)
|
|
}
|
|
}
|
|
|
|
export { nextInfo }
|
|
|
|
function getPackageVersion(packageName: string) {
|
|
try {
|
|
return require(`${packageName}/package.json`).version
|
|
} catch {
|
|
return 'N/A'
|
|
}
|
|
}
|
|
|
|
function getBinaryVersion(binaryName: string) {
|
|
try {
|
|
return childProcess
|
|
.execFileSync(binaryName, ['--version'])
|
|
.toString()
|
|
.trim()
|
|
} catch {
|
|
return 'N/A'
|
|
}
|
|
}
|