fix(cli): add built-in reporters list to --help output (#7955)

Author: pengooseDev

docs/guide/cli-generated.md

@@ -89,7 +89,9 @@ Hide logs for skipped tests
 - **CLI:** `--reporter <name>`
 - **Config:** [reporters](/config/#reporters)
 
-Specify reporters
+Specify which reporter(s) to use. Available values:
+
+`default`, `basic`, `blob`, `verbose`, `dot`, `json`, `tap`, `tap-flat`, `junit`, `hanging-process`, `github-actions`.
 
 ### outputFile
 

packages/vitest/src/node/cli/cli-config.ts

@@ -7,6 +7,7 @@ import type {
 } from '../types/pool-options'
 import type { CliOptions } from './cli-api'
 import { defaultBrowserPort, defaultPort } from '../../constants'
+import { ReportersMap } from '../reporters'
 
 type NestedOption<T, V = Extract<T, Record<string, any>>> = V extends
   | never
@@ -160,7 +161,7 @@ export const cliOptionsConfig: VitestCLIOptions = {
   },
   reporters: {
     alias: 'reporter',
-    description: 'Specify reporters',
+    description: `Specify reporters (${Object.keys(ReportersMap).join(', ')})`,
     argument: '<name>',
     subcommands: null, // don't support custom objects
     array: true,

packages/vitest/src/node/reporters/index.ts

@@ -31,8 +31,8 @@ export {
 }
 export type { BaseReporter, Reporter, TestRunEndReason }
 
+export type { BenchmarkBuiltinReporters } from './benchmark'
 export {
-  BenchmarkBuiltinReporters,
   BenchmarkReporter,
   BenchmarkReportsMap,
   VerboseBenchmarkReporter,

test/core/test/cli-test.test.ts

@@ -1,5 +1,6 @@
 import { resolveConfig as viteResolveConfig } from 'vite'
 import { expect, test } from 'vitest'
+import { ReportersMap } from 'vitest/reporters'
 import { createCLI, parseCLI } from '../../../packages/vitest/src/node/cli/cac.js'
 import { resolveConfig } from '../../../packages/vitest/src/node/config/resolveConfig.js'
 
@@ -465,3 +466,19 @@ test('public parseCLI works correctly', () => {
     },
   })
 })
+
+test('should include builtin reporters list', () => {
+  let helpText = ''
+  vitestCli.help((sections) => {
+    for (const section of sections) {
+      helpText += section.body
+    }
+  })
+  vitestCli.parse(['node', '/index.js', '--help'], { run: false })
+  const match = helpText.match(/--reporter[^(]*\(([^)]+)\)/)
+  expect(match).not.toBeNull()
+
+  const listed = match![1].split(',').map(s => s.trim()).filter(Boolean)
+  const expected = Object.keys(ReportersMap)
+  expect(new Set(listed)).toEqual(new Set(expected))
+})