Giter Club home page Giter Club logo

retext-overuse's Introduction

retext-overuse Build Status

Check phrases for overuse with retext.

Installation

npm:

npm install retext-overuse

retext-overuse is also available for duo, and as an AMD, CommonJS, and globals module, uncompressed and compressed.

Usage

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

MIT © Duncan Beaton

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.