@cspell/cspell-json-reporter
CSpell reporter with JSON output
Usage
Add this to 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 issuesresult
- CSpell linting resultserror
- CSell error messagesprogress
- file linting progress messages if settings.progress
is enabledinfo
- CSpell execution logs if settings.verbose
is enableddebug
- CSpell debug logs if settings.debug
is enabled
See CSpellJSONReporterOutput for more info.
Settings
Possible settings:
outFile
(required) - path for JSON file to emitverbose
(default: false) - enable saving of execution logsdebug
(default: false) - enable saving of debug logsprogress
(default: false) - enable saving of file progress logs
See CSpellJSONReporterSettings for more info.