@cspell/cspell-json-reporter
v9.4.0
Published
JSON reporter for CSpell
Readme
@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-reporterUsage
Using Command Line
cspell . --reporter @cspell/cspell-json-reporterUsing CSpell Configuration
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 issuesresult- CSpell linting resultserror- CSell error messagesprogress- file linting progress messages ifsettings.progressis enabledinfo- CSpell execution logs ifsettings.verboseis enableddebug- CSpell debug logs ifsettings.debugis enabled
