@cspell/cspell-json-reporter

@cspell/cspell-json-reporter

CSpell reporter with JSON output

Installation

Install it as a development package in the repository that will use it.

npm install -SD @cspell/cspell-json-reporter

Usage

Add this to cspell.yaml:

reporters: [['@cspell/cspell-json-reporter', { outFile: 'out.json' }]]

or cspell.json

{
  "reporters": [["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]
}

Output file format

@cspell/cspell-json-reporter emits a JSON file with the following fields:

• issues - found spelling issues
• result - CSpell linting results
• error - CSell error messages
• progress - file linting progress messages if settings.progress is enabled
• info - CSpell execution logs if settings.verbose is enabled
• debug - CSpell debug logs if settings.debug is enabled

See CSpellJSONReporterOutput for more info.

Settings

Possible settings:

• outFile (required) - path for JSON file to emit
• verbose (default: false) - enable saving of execution logs
• debug (default: false) - enable saving of debug logs
• progress (default: false) - enable saving of file progress logs

See CSpellJSONReporterSettings for more info.