retext-repeated-words
retext plugin to check for repeated words.for
Install
npm:
npm install retext-repeated-words
Use
Say we have the following file, example.txt
:
Well, it it doesn’t have to to be. Like a fish in the
the sea.
…and our script, example.js
, looks like this:
var vfile = require('to-vfile')
var report = require('vfile-reporter')
var unified = require('unified')
var english = require('retext-english')
var stringify = require('retext-stringify')
var repeated = require('retext-repeated-words')
unified()
.use(english)
.use(repeated)
.use(stringify)
.process(vfile.readSync('example.txt'), function(err, file) {
console.error(report(err || file))
})
Now, running node example
yields:
example.txt
1:7-1:12 warning Expected `it` once, not twice it retext-repeated-words
1:26-1:31 warning Expected `to` once, not twice to retext-repeated-words
1:51-2:4 warning Expected `the` once, not twice the retext-repeated-words
⚠ 3 warnings
API
retext().use(repeatedWords)
Check for repeated words.
- Doesn’t warn for some words which do occur twice (
the best exhibition they had had since
) - Doesn’t warn for initialisms (
D. D. will pop up with…
) - Doesn’t warn for capitalised words (
Duran Duran…
)
Messages
Each message is emitted as a VFileMessage
on file
, with the following fields:
message.source
Name of this plugin ('retext-repeated-words'
).
message.ruleId
Repeated word (normalized) (string
, such as the
).
message.actual
Current not ok phrase (string
).
message.expected
List of suggestions (Array.<string>
, such as ['the']
).
Related
retext-indefinite-article
— Check if indefinite articles are used correctlyretext-redundant-acronyms
— Check for redundant acronyms
Contribute
See contributing.md
in retextjs/.github
for ways to get started. See support.md
for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.