retext-overuse

Check words for overuse with Retext

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
retext-overuse
1.1.17 years ago8 years agoMinified + gzip package size for retext-overuse in KB

Readme

Check phrases for overuse with retextretext.

Installation

npm install retext-overuse
**retext-overuse** is also available for [duo][duo-install], and as an
AMD, CommonJS, and globals module, [uncompressed and compressed][releases].

## Usage

```js
var retext = require('retext');
var overuse = require('retext-overuse');
var report = require('vfile-reporter');

retext()
    .use(overuse)
    .process([
		'That movie was amazing',
		'The acting was amazing',
		'The story was amazing'
    ].join('\n'), function (err, file) {
        console.log(report(file));
    });

Yields:
<stdin>
	1:16-1:23: Replace “amazing” with “astonishing”, “surprising”, “awe-inspiring”, “awesome”, “awful”, “awing”, “impressive”
	2:16-2:23: Replace “amazing” with “astonishing”, “surprising”, “awe-inspiring”, “awesome”, “awful”, “awing”, “impressive”
	3:15-3:22: Replace “amazing” with “astonishing”, “surprising”, “awe-inspiring”, “awesome”, “awful”, “awing”, “impressive”

⚠ 3 warnings

API

retext.use(overuse[, options])

Word overuse with Retext.
Parameters
  • overuse — This plug-in;

  • options (Object?, optional):
*   `list` (`Object.<Object>`)
    — Phrases with suggestions.

*   `ignore` (`Object.<Array>`)
    — Phrases in the list to ignore.

*   `limit` (`Number`)
    — Number of times phrase must have been used.

License

MITlicense © Duncan Beatonauthor