English prose and spellchecker build on nodehun & write-good
Built with ❤︎ by tiaanduplessis and contributors
$ npm install proofread-core
# OR
$ yarn add proofread-coreconst proofRead = require('proofread-core')
proofRead(`
So the cat was stolen.
Cuz for reasons.
`)
.then(console.log)
.catch(console.error)
// { suggestions:
// [ { index: 0, offset: 2, reason: '"So" adds no meaning' },
// { index: 11,
// offset: 10,
// reason: '"was stolen" may be passive voice' } ],
// typos: [ { word: 'Cuz', suggestions: [Array], positions: [Array] } ] }Optionally specify the dictionary (see dictionaries directory for available english dictionaries) to use and any of the available write-good options.
proofRead(`
So the cat was stolen.
Cuz for reasons.
`, {
dictionary: 'us',
passive: false
})
.then(console.log)
.catch(console.error)Contributions are welcome!
- Fork it.
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
Or open up a issue.
Licensed under the MIT License.
![greenkeeper[bot] avatar](https://avatars.githubusercontent.com/in/505?v=4 "greenkeeper[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent