feat(info): add --json output

Author: danielroe

packages/nuxt-cli/src/commands/info.ts

@@ -10,12 +10,14 @@ import { defineCommand } from 'citty'
 
 import{detectPackageManager}from'nypm'
 import{readPackageJSON}from'pkg-types'
+import{camelCase}from'scule'
 import{isBun,isDeno,isMinimal}from'std-env'
 import{writeText}from'tinyclip'
 import{versionasnuxiVersion}from'../../package.json'
 
 import{getBuilder}from'../utils/banner'
 import{resolveCatalogEntry}from'../utils/catalog'
+import{withDirectStdout}from'../utils/console'
 import{formatInfoBox}from'../utils/formatting'
 import{tryResolveNuxt}from'../utils/kit'
 import{logger}from'../utils/logger'
@@ -28,13 +30,33 @@ import { rootDirArgs } from './_shared'
 
 constLEADING_SLASH_RE=/^\//
 
+/** JSON key for each display label, so `--json` output stays stable if a label is reworded. */
+constJSON_KEYS: Record<string,string>={
+'Operating system': 'operatingSystem',
+'CPU': 'cpu',
+'Bun version': 'bunVersion',
+'Deno version': 'denoVersion',
+'Node.js version': 'nodeVersion',
+'nuxt/cli version': 'cliVersion',
+'Package manager': 'packageManager',
+'Nuxt version': 'nuxtVersion',
+'Nitro version': 'nitroVersion',
+'Builder': 'builder',
+'Config': 'config',
+'Modules': 'modules',
+}
+
 exportdefaultdefineCommand({
 meta: {
 name: 'info',
 description: 'Get information about Nuxt project',
 },
 args: {
  ...rootDirArgs,
+json: {
+type: 'boolean',
+description: 'Print project info as JSON',
+},
 },
 asyncrun(ctx){
 constcwd=resolveRootDir(ctx.args)
@@ -63,13 +85,15 @@ export default defineCommand({
 constspecifier=Array.isArray(module) ? module[0] : module
 constpackageName=typeofspecifier==='string'&&getPackageName(specifier)
 constversion=packageName&&awaitgetDepVersion(packageName)
-return`\`${version ? `${name}@${version}` : name}\``
+returnversion ? `${name}@${version}` : name
 }))
 const[modules,nuxtVersion='-',nitroVersion]=awaitPromise.all([
 modulesPromise,
 getDepVersion('nuxt').then(version=>version||getDepVersion('nuxt-nightly')),
 resolveNitroVersion(cwd,getDepVersion),
 ])
+constconfigKeys=Object.keys(nuxtConfig).sort()
+constmoduleNames=modules.filter(module=>module!==null)
 constbuilder=nuxtConfig.builder||'vite'
 constpackageManager=detectedPackageManager
  ? `${detectedPackageManager.name}@${getPackageManagerVersion(detectedPackageManager.command)}`
@@ -95,11 +119,23 @@ export default defineCommand({
 'Nuxt version': nuxtVersion,
 'Nitro version': nitroVersion,
 'Builder': builderInfo.name==='custom' ? 'custom' : `${builderInfo.name.toLowerCase()}@${builderInfo.version}`,
-'Config': Object.keys(nuxtConfig)
-.map(key=>`\`${key}\``)
-.sort()
-.join(', '),
-'Modules': modules.filter(module=>module!==null).join(', '),
+'Config': configKeys.map(key=>`\`${key}\``).join(', '),
+'Modules': moduleNames.map(name=>`\`${name}\``).join(', '),
+}
+
+if(ctx.args.json){
+// Arrays come from the source values rather than the rendered string, so a
+// key or module path containing `, ` stays a single entry.
+constlists: Record<string,string[]>={config: configKeys,modules: moduleNames}
+constpayload=JSON.stringify({
+rootDir: nuxtConfig.rootDir||cwd,
+ ...Object.fromEntries(Object.entries(infoObj).map(([label,value])=>{
+constkey=JSON_KEYS[label]??camelCase(label)
+return[key,lists[key]??(value?.replaceAll('`','')||null)]
+})),
+},null,2)
+awaitwithDirectStdout(()=>process.stdout.write(`${payload}\n`))
+return
 }
 
 logger.info(`Nuxt root directory: ${styleText('cyan',nuxtConfig.rootDir||cwd)}\n`)

packages/nuxt-cli/test/unit/help.spec.ts

@@ -279,6 +279,10 @@ describe('help', () => {
  ARGUMENTS
 
  ROOTDIR The root directory of your Nuxt project (default: .)
+
+ OPTIONS
+
+ --json Print project info as JSON
  "
  `)
 })