Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too.
npm install write-goodImportant: Do not use this tool to be a jerk to other people about their writing.
writeGood is a function that takes a string and returns an array of suggestions.
var writeGood = require('write-good');
var suggestions = writeGood('So the cat was stolen.');
// suggestions:
//
// [{
// suggestion: "omit 'So' from the beginning of sentences",
// index: 0, offset: 2
// }, {
// suggestion: "'was stolen' is passive voice",
// index: 11, offset: 10
// }]writeGood takes an optional second argument that allows you to disable certain checks.
You can disable checking for passive voice like this:
var writeGood = require('write-good');
var suggestions = writeGood('So the cat was stolen', { passive: false});
// suggestions: []You can use the second argument's checks property to pass in custom checks instead of write-good's default linting configuration.
Like this, you can check non-English documents, for example with the linter extension for German, schreib-gut:
var schreibGut = require('schreib-gut');
writeGood('Aller Wahrscheinlichkeit nach können Entwickler nicht gut schreiben', { weasel-words: false, checks: schreibGut});
// suggestions
// [{index : 0, offset : 29, reason : '"Aller Wahrscheinlichkeit nach" is wordy or unneeded' }]You can use write-good as a command-line tool by installing it globally:
npm install -g write-goodwrite-good takes a glob and prints suggestions to stdout:
$ write-good *.md
In README.md
=============
= writeGood('So the cat was stolen.');
^^^^^^^^^^
"was stolen" is passive voice on line 20 at column 40
-------------
// suggestion: "'was stolen' is passive voice",
^^^^^^^^^^
"was stolen" is passive voice on line 28 at column 19You can run just specific checks like this:
write-good *.md --weasel --soOr exclude checks like this:
write-good *.md --no-passiveOr include checks like this:
# E-Prime is disabled by default.
write-good *.md --yes-eprimeNote: The --yes prefix only works for E-Prime, because the other checks are included by default, anyway.
You can run just with text without supplying files:
write-good --text="It should have been defined there."You can even supply multi-line text:
write-good --text="I can't see a problem there that's not been defined yet.
Should be defined again."You can also pass other arguments:
write-good --text="It should have been defined there." --no-passiveYou can even fetch output from a remote file:
write-good --text="$(curl https://raw.githubusercontent.com/btford/write-good/master/README.md)"Use the --parse option to activate parse-happy output and a more conventional Unix exit code:
write-good *.md --parseTo specify a custom checks extension, for example schreib-gut, run:
npm install -g schreib-gut
write-good *.md --checks=schreib-gutYou can disable any combination of the following by providing a key with value false as the second argument to writeGood.
Checks for passive voice.
Checks for lexical illusions – cases where a word is repeated.
Checks for so at the beginning of the sentence.
Checks for there is or there are at the beginning of the sentence.
Checks for "weasel words."
Checks for adverbs that can weaken meaning: really, very, extremely, etc.
Checks for wordy phrases and unnecessary words.
Checks for common cliches.
Checks for "to-be" verbs. Disabled by default
Users can create their own write-good language checks. As described above,
you can specify such extensions when running write-good on the command line
or calling it in your JavaScript code.
The following 3rd-party write-good extensions are available:
- schreib-gut: A basic extension for the German language
If you know of any write-good extensions that are not in this list, please open a pull request!
An extension is a Node.js module that exposes an object containing a check
function (fn) and an explanation string for each new check:
module.exports = {
check1: {
fn: function(text) {
…
},
explanation: '…'
},
check2: {
fn: function(text) {
…
},
explanation: '…'
}
}Each check function takes a string input and determines a list of style
violation objects, each with an index and an offset:
/**
* @param {text} text Input text
* @return {{index:number, offset:number}[]} List of all violations
*/The index defines the position of the match in the input text, whereas the
offset specifies the length of the match.
The following example extension provides a check that determines if the input text contains a set of forbidden terms (Tom Riddle and Voldemort):
module.exports = {
voldemort: {
fn: function (text) {
var positives = ['Tom Riddle', 'Voldemort']
var re = new RegExp('\\b(' + positives.join('|') + ')\\b', 'gi');
var suggestions = [];
while (match = re.exec(text)) {
suggestions.push({
index: match.index,
offset: match[0].length,
});
}
return suggestions;
},
explanation: 'You must not name Him-Who-Must-Not-Be-Named'
}
}I came across these resources while doing research to make this module. They might be helpful.
- shell script for avoiding "weasel words" – I based my initial implementation on this
- Academic Writing Check – a perl script similar to above
- writegood mode for emacs
- natural – general purpose NLP toolkit in JavaScript
- WordNet – lexical database of the English language
- LanguageTool – style and grammar checker implemented in Java
- Elements of Style
- Flesch–Kincaid readability
- Fear and Loathing of the English passive
- Words to Avoid in Educational Writing
This is not an endorsement. These apps have similar functionality that you may find useful.
- linter-write-good for Atom
- Write Good action for Drafts iOS App
- Write Good Linter for Visual Studio Code
- Vim ALE realtime linter for Vim with included support for write-good.
MIT