Skip to main content

Type Alias: ReporterSettings

ReporterSettings = ReporterModuleName | [name: ReporterModuleName] | [name: ReporterModuleName, options: ReporterOptions]

Defined in: packages/cspell-types/dist/index.d.mts:2162

Declare a reporter to use.

default - is a special name for the default cli reporter.

Examples:

  • "default" - to use the default reporter
  • "@cspell/cspell-json-reporter" - use the cspell JSON reporter.
  • ["@cspell/cspell-json-reporter", { "outFile": "out.json" }]