Simple text proofreader based on 'write-good' (hemingway-app-like suggestions) and 'nodehun' (spelling).
npm install @anthonyjclark/proofreader
In this fork, I am stripping out a lot of the functionality and just using the proofreader.js library (i.e., I am ignoring the cmd.js binary and the sourceloader.js library).
Proofreader  
===========
Proofreader takes a website, or a local file, and tries to proofread it using write-good and nodehun.
proofreader -u https://raw.githubusercontent.com/GoogleChrome/devtools-docs/master/docs/memory-analysis-101.html
proofreader -f ../devtools-docs/docs/commandline-api.md
proofreader -l list-of-files.txt
proofreader -c custom-config.json -f file.html
Output:
!Console output
- blue suggestions come from write-good
- magenta suggestions come from nodehun
```
../docs/file.html
/home/developer/otherfile.md
http://localhost/remote-file.md
). This file has to be a valid JSON. Sample configuration:`
{
"dictionaries": {
"build-in": ["en_US", "en_GB"],
"custom": ["devtools-docs.dic"]
},
"selectors": {
"whitelist": "p, li, h1, h2, h3, h4, th, td, dl, figcaption",
"blacklist": "pre, code"
},
"write-good": {
"weasel": false
}
}
`- dictionaries
- build-in - one or two of build in dictionaries (
eng_GB, eng_US). E.g. when both American English and British English are allowed, ["en_US", "en_GB"]` should be specified.- optimized for Chrome DevTools docs
- optimized for HTML and Markdown
- optimized for English
- by default does not process all the tags, only whitelisted ones (e.g. P, LI, H1, H2, H3)