How can i export the result?

[syeda-git]

Is there a way to export the results of the run to say an HTML file?
I would like to use cspell as part of CI/CD pipeline. So, an output file is expected.

Syed

[Jason3S]

@syeda-git,

The cspell-json-reporter will output a JSON file.

It is also possible to write your own reporter.

[syeda-git]

@Jason3S

When i add the following code to cspell.json, i get error. Please let me know what am i missing.

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

[Jason3S]

@syeda-git,

Looks like the documentation is wrong. That is valid Yaml, but not valid JSON.

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

A few things:

1. I suggest running the spell checker from the same directory to be spell checked:

   D:\test\spell\test>cspell "**/*.md"
   

2. You will need to install the reporter:
   Globally:
   npm i -g @cspell/cspell-json-reporter
   or locally: npm i -D @cspell/cspell-json-reporter