feat(module,task): add --json to module search and task list

Author: danielroe

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

@@ -62,3 +62,10 @@ export const rootDirArgs = {
 default: undefined,
 },
 }asconstsatisfiesRecord<string,ArgDef>
+
+exportconstjsonArgs={
+json: {
+type: 'boolean',
+description: 'Print output as JSON',
+},
+}asconstsatisfiesRecord<string,ArgDef>

packages/nuxt-cli/src/commands/module/search.ts

@@ -6,11 +6,12 @@ import { defineCommand } from 'citty'
 importfuzzysortfrom'fuzzysort'
 import{kebabCase,upperFirst}from'scule'
 
+import{withDirectStdout}from'../../utils/console'
 import{formatInfoBox}from'../../utils/formatting'
 import{logger}from'../../utils/logger'
 import{logNetworkError}from'../../utils/network'
 import{DEFAULT_NUXT_VERSION,getNuxtVersion}from'../../utils/versions'
-import{cwdArgs}from'../_shared'
+import{cwdArgs,jsonArgs}from'../_shared'
 import{checkNuxtCompatibility,fetchModules,MODULES_API_URL}from'./_utils'
 
 constDASH_RE=/-/g
@@ -48,12 +49,13 @@ export default defineCommand({
 required: false,
 valueHint: '2|3',
 },
+ ...jsonArgs,
 },
 asyncsetup(ctx){
 constnuxtVersion=ctx.args.nuxtVersion
  ? normalizeNuxtVersion(ctx.args.nuxtVersion)
  : awaitgetNuxtVersion(ctx.args.cwd).catch(()=>DEFAULT_NUXT_VERSION)
-returnfindModuleByKeywords(ctx.args._.join(' '),nuxtVersion)
+returnfindModuleByKeywords(ctx.args._.join(' '),nuxtVersion,ctx.args.json)
 },
 })
 
@@ -65,7 +67,7 @@ export function normalizeNuxtVersion(version: string): string {
  : version
 }
 
-asyncfunctionfindModuleByKeywords(query: string,nuxtVersion: string){
+asyncfunctionfindModuleByKeywords(query: string,nuxtVersion: string,json?: boolean){
 constallModules=awaitfetchModules().catch((err)=>{
 logNetworkError(err,{url: MODULES_API_URL})
 process.exit(1)
@@ -86,11 +88,33 @@ async function findModuleByKeywords(query: string, nuxtVersion: string) {
 ].filter(Boolean).join(' ')),
 }))
 
-constresults=fuzzysort.go(query,targets,{
+constmatches=fuzzysort.go(query,targets,{
 keys: ['name','npm','rest'],
 threshold: SCORE_THRESHOLD,
 limit: RESULT_LIMIT,
-}).map(({obj: { item }})=>{
+}).map(({obj: { item }})=>item)
+
+if(json){
+constpayload=JSON.stringify({
+ query,
+ nuxtVersion,
+modules: matches.map(item=>({
+name: item.name,
+package: item.npm,
+description: item.description,
+homepage: item.website,
+repository: item.github,
+compatibility: item.compatibility?.nuxt||'*',
+stars: item.stats.stars,
+monthlyDownloads: item.stats.downloads,
+install: `npx nuxt add ${item.name}`,
+})),
+},null,2)
+awaitwithDirectStdout(()=>process.stdout.write(`${payload}\n`))
+return
+}
+
+constresults=matches.map((item)=>{
 constres: Record<string,string>={
 name: item.name,
 package: item.npm,

packages/nuxt-cli/src/commands/task/list.ts

@@ -5,9 +5,10 @@ import { styleText } from 'node:util'
 
 import{defineCommand}from'citty'
 
+import{withDirectStdout}from'../../utils/console'
 import{logger}from'../../utils/logger'
 import{resolveRootDir}from'../../utils/paths'
-import{rootDirArgs}from'../_shared'
+import{jsonArgs,rootDirArgs}from'../_shared'
 import{emptyTaskListHint,fetchTasks,missingTaskRoutesHint,reportTaskError,resolveTaskServer,taskArgs}from'./_utils'
 
 exportdefaultdefineCommand({
@@ -18,6 +19,7 @@ export default defineCommand({
 args: {
  ...rootDirArgs,
  ...taskArgs,
+ ...jsonArgs,
 },
 asyncrun(ctx){
 constcwd=resolveRootDir(ctx.args)
@@ -35,6 +37,15 @@ export default defineCommand({
 const{ tasks ={}, scheduledTasks }=(response.data||{})asTaskList
 constnames=Object.keys(tasks).sort()
 
+if(ctx.args.json){
+constpayload=JSON.stringify({
+tasks: names.map(name=>({ name,description: tasks[name]?.description||null})),
+scheduledTasks: (scheduledTasks||[]).map(({ cron, tasks })=>({ cron, tasks })),
+},null,2)
+awaitwithDirectStdout(()=>process.stdout.write(`${payload}\n`))
+return
+}
+
 if(names.length===0){
 logger.info(`No tasks found. ${awaitemptyTaskListHint(cwd)}`)
 return

packages/nuxt-cli/test/unit/commands/module/search.spec.ts

@@ -0,0 +1,79 @@
+importprocessfrom'node:process'
+
+import{runCommand}from'citty'
+import{afterEach,beforeEach,describe,expect,it,vi}from'vitest'
+
+importsearchfrom'../../../../src/commands/module/search'
+
+const{ fetchModules }=vi.hoisted(()=>({fetchModules: vi.fn()}))
+
+vi.mock('../../../../src/commands/module/_utils',async(importOriginal)=>{
+constoriginal=awaitimportOriginal<typeofimport('../../../../src/commands/module/_utils')>()
+return{ ...original,fetchModules}
+})
+
+functionmoduleEntry(name: string){
+return{
+ name,
+npm: `nuxt-${name}`,
+repo: `nuxt-modules/${name}`,
+github: `https://github.com/nuxt-modules/${name}`,
+website: `https://${name}.nuxtjs.org`,
+description: `The ${name} module`,
+category: 'Devtools',
+tags: [name],
+compatibility: {nuxt: '^3.0.0 || ^4.0.0'},
+maintainers: [{name: 'someone',github: 'someone'}],
+stats: {stars: 1234,downloads: 56_789},
+}
+}
+
+letstdout: string
+
+describe('module search',()=>{
+beforeEach(()=>{
+stdout=''
+fetchModules.mockResolvedValue([moduleEntry('image'),moduleEntry('content')])
+vi.spyOn(process.stdout,'write').mockImplementation((chunk: any)=>{
+stdout+=String(chunk)
+returntrue
+})
+})
+
+afterEach(()=>{
+vi.restoreAllMocks()
+})
+
+it('prints machine readable results with `--json`',async()=>{
+awaitrunCommand(search,{rawArgs: ['image','--json','--nuxtVersion','4.0.0']})
+
+expect(JSON.parse(stdout)).toEqual({
+query: 'image',
+nuxtVersion: '4.0.0',
+modules: [{
+name: 'image',
+package: 'nuxt-image',
+description: 'The image module',
+homepage: 'https://image.nuxtjs.org',
+repository: 'https://github.com/nuxt-modules/image',
+compatibility: '^3.0.0 || ^4.0.0',
+stars: 1234,
+monthlyDownloads: 56_789,
+install: 'npx nuxt add image',
+}],
+})
+})
+
+it('prints an empty module list with `--json` when nothing matches',async()=>{
+awaitrunCommand(search,{rawArgs: ['zzzzzz','--json','--nuxtVersion','4.0.0']})
+
+expect(JSON.parse(stdout)).toEqual({query: 'zzzzzz',nuxtVersion: '4.0.0',modules: []})
+})
+
+it('leaves the human output untouched without `--json`',async()=>{
+awaitrunCommand(search,{rawArgs: ['image','--nuxtVersion','4.0.0']})
+
+expect(stdout).toContain('image')
+expect(()=>JSON.parse(stdout)).toThrow()
+})
+})

packages/nuxt-cli/test/unit/commands/task.spec.ts

@@ -156,6 +156,27 @@ describe('task list', () => {
 expect(stdout).toContain('0 * * * *')
 })
 
+it('prints machine readable output with `--json`',async()=>{
+constcode=awaitrunTaskCommand(list,['--url',origin,'--json'])
+
+expect(code).toBe(0)
+expect(JSON.parse(stdout)).toEqual({
+tasks: [
+{name: 'db:migrate',description: 'Migrate the database'},
+{name: 'db:seed',description: null},
+],
+scheduledTasks: [{cron: '0 * * * *',tasks: ['db:seed']}],
+})
+})
+
+it('prints an empty payload with `--json` when the server exposes no tasks',async()=>{
+taskList={tasks: {}}
+constcode=awaitrunTaskCommand(list,['--url',origin,`--cwd=${cwd}`,'--json'])
+
+expect(code).toBe(0)
+expect(JSON.parse(stdout)).toEqual({tasks: [],scheduledTasks: []})
+})
+
 it('finds the dev server from the lock file',async()=>{
 awaitwriteLock(origin)
 constcode=awaitrunTaskCommand(list,[`--cwd=${cwd}`])

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

@@ -491,6 +491,7 @@ describe('help', () => {
 
  --cwd=<directory> Specify the root directory of your Nuxt project (Default: .) 
  --nuxtVersion=<2|3> Filter by Nuxt version and list compatible modules only (auto detected by default)
+ --json Print output as JSON 
  "
  `)
 })