retext-cliches
v1.0.0
Published
Check phrases for cliches
Downloads
12
Maintainers
Readme
retext-cliches
Check phrases for cliches with retext.
Installation
npm:
npm install retext-cliches
retext-cliches is also available for duo, and as an AMD, CommonJS, and globals module, uncompressed and compressed.
Usage
var retext = require('retext');
var cliches = require('retext-cliches');
var report = require('vfile-reporter');
retext()
.use(cliches)
.process([
'You can use cliches until the until the cows come home.',
'Sorry to burst your bubble',
'but you will sound like a broken record.',
].join('\n'), function (err, file) {
console.log(report(file));
});
Yields:
<stdin>
1:31-1:55: Warning: “until the cows come home” is a cliche
2:10-2:27: Warning: “burst your bubble” is a cliche
3:27-3:40: Warning: “broken record” is a cliche
⚠ 3 warnings
API
retext.use(cliches[, options])
Check phrases for cliches.
Parameters
cliches
— This plug-in;options
(Object?
, optional):ignore
(Array.<string>
) — List of phrases to not warn about.