feat(cli): introduce next info CLI command

.github/ISSUE_TEMPLATE/1.bug_report.yml

@@ -14,6 +14,12 @@ body:
   - type: markdown
     attributes:
       value: 'next@canary is the beta version of Next.js. It includes all features and fixes that are pending to land on the stable release line.'
+  - type: textarea
+    attributes:
+      label: Run `next info` (available from version 12.0.8 and up)
+      description: Please run `next info` in the root directory of your project and paste the results. You might need to use `npx --no-install next info` if next is not in the current PATH.
+    validations:
+      required: false
   - type: input
     attributes:
       label: What version of Next.js are you using?

docs/api-reference/cli.md

@@ -21,7 +21,7 @@ Usage
   $ next <command>
 
 Available commands
-  build, start, export, dev, lint, telemetry
+  build, start, export, dev, lint, telemetry, info
 
 Options
   --version, -v   Version number
@@ -125,3 +125,36 @@ Next.js collects **completely anonymous** telemetry data about general usage.
 Participation in this anonymous program is optional, and you may opt-out if you'd not like to share any information.
 
 To learn more about Telemetry, [please read this document](https://nextjs.org/telemetry/).
+
+## Info
+
+`next info` prints relevant details about the current system which can be used to report Next.js bugs.
+This information includes Operating System platform/arch/version, Binaries (Node.js, npm, Yarn, pnpm) and npm package versions (`next`, `react`, `react-dom`).
+
+Running the following in your project's root directory:
+
+```bash
+next info
+```
+
+will give you information like this example:
+
+```bash
+
+    Operating System:
+      Platform: linux
+      Arch: x64
+      Version: #22-Ubuntu SMP Fri Nov 5 13:21:36 UTC 2021
+    Binaries:
+      Node: 16.13.0
+      npm: 8.1.0
+      Yarn: 1.22.17
+      pnpm: 6.24.2
+    Relevant packages:
+      next: 12.0.8
+      react: 17.0.2
+      react-dom: 17.0.2
+
+```
+
+This information should then be pasted into GitHub Issues.

package.json

@@ -56,6 +56,7 @@
     "@types/fs-extra": "8.1.0",
     "@types/http-proxy": "1.17.3",
     "@types/jest": "24.0.13",
+    "@types/node": "13.11.0",
     "@types/selenium-webdriver": "4.0.15",
     "@types/sharp": "0.29.3",
     "@types/string-hash": "1.1.1",

packages/next/bin/next.ts

@@ -23,6 +23,7 @@ const commands: { [command: string]: () => Promise<cliCommand> } = {
   lint: () => Promise.resolve(require('../cli/next-lint').nextLint),
   telemetry: () =>
     Promise.resolve(require('../cli/next-telemetry').nextTelemetry),
+  info: () => Promise.resolve(require('../cli/next-info').nextInfo),
 }
 
 const args = arg(

packages/next/cli/next-info.ts

@@ -0,0 +1,76 @@
+#!/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 { 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
+  }
+
+  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: ${getPackageVersion('next')}
+      react: ${getPackageVersion('react')}
+      react-dom: ${getPackageVersion('react-dom')}`)
+}
+
+export { nextInfo }
+
+function getPackageVersion(packageName: string) {
+  try {
+    return require(`${packageName}/package.json`).version
+  } catch {
+    return 'N/A'
+  }
+}
+
+function getBinaryVersion(binaryName: string) {
+  try {
+    return childProcess.execSync(`${binaryName} --version`).toString().trim()
+  } catch {
+    return 'N/A'
+  }
+}

packages/next/shared/lib/utils.ts

@@ -456,6 +456,6 @@ export interface CacheFs {
   readFile(f: string): Promise<string>
   readFileSync(f: string): string
   writeFile(f: string, d: any): Promise<void>
-  mkdir(dir: string): Promise<void>
+  mkdir(dir: string): Promise<void | string>
   stat(f: string): Promise<{ mtime: Date }>
 }

test/integration/cli/test/index.test.js

@@ -400,4 +400,47 @@ describe('CLI Usage', () => {
       expect(stderr).not.toContain('UnhandledPromiseRejectionWarning')
     })
   })
+
+  describe('info', () => {
+    test('--help', async () => {
+      const help = await runNextCommand(['info', '--help'], {
+        stdout: true,
+      })
+      expect(help.stdout).toMatch(
+        /Prints relevant details about the current system which can be used to report Next\.js bugs/
+      )
+    })
+
+    test('-h', async () => {
+      const help = await runNextCommand(['info', '-h'], {
+        stdout: true,
+      })
+      expect(help.stdout).toMatch(
+        /Prints relevant details about the current system which can be used to report Next\.js bugs/
+      )
+    })
+
+    test('should print output', async () => {
+      const info = await runNextCommand(['info'], {
+        stdout: true,
+      })
+      expect(info.stdout).toMatch(
+        new RegExp(`
+    Operating System:
+      Platform: .*
+      Arch: .*
+      Version: .*
+    Binaries:
+      Node: .*
+      npm: .*
+      Yarn: .*
+      pnpm: .*
+    Relevant packages:
+      next: .*
+      react: .*
+      react-dom: .*
+`)
+      )
+    })
+  })
 })

yarn.lock

@@ -4694,9 +4694,10 @@
   dependencies:
     "@types/node" "*"
 
-"@types/node@*", "@types/node@>= 8":
-  version "13.1.4"
-  resolved "https://registry.yarnpkg.com/@types/node/-/node-13.1.4.tgz#4cfd90175a200ee9b02bd6b1cd19bc349741607e"
+"@types/node@*", "@types/[email protected]", "@types/node@>= 8":
+  version "13.11.0"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-13.11.0.tgz#390ea202539c61c8fa6ba4428b57e05bc36dc47b"
+  integrity sha512-uM4mnmsIIPK/yeO+42F2RQhGUIs39K2RFmugcJANppXe6J1nvH87PvzPZYpza7Xhhs8Yn9yIAVdLZ84z61+0xQ==
 
 "@types/[email protected]":
   version "10.12.18"