search

tbroadley / spellchecker-cli

A command-line tool for spellchecking files.
MIT License
119 stars 16 forks source link

How do I use --reports exactly? #78

Closed p2635 closed 3 years ago

p2635 commented 3 years ago

I added --reports myreport.txt at the end hoping to get a summary of a spellcheck I did. But I could not find the file in the same directory. Can someone give me an example usage of this command?

YenHub commented 3 years ago

Hey @p2635

There are two types of reports you can use, check the docs on them here, however, .txt is not a supported report type.

Basically, you've got either XML or JSON.

To use JSON, simply do:- 

spellchecker --files **/*.ts --reports report.json

This will output a file called "report.json" at the root of the folder from which you have run spellchecker

Hope this helps!

YenHub 😎