Code Monkey home page Code Monkey 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

retext-overuse's People

Contributors

dunckr avatar nodatall avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

retext-overuse's Issues

File.warn not a function with a solution need to update it

var retext = require('retext');
var overuse = require('retext-overuse');

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

TypeError: Cannot read property 'message' of undefined
at /home/vignesh/Documents/master2/PET_Project/spellcheck/Test1.js:18:16
at done (/home/vignesh/Documents/master2/PET_Project/spellcheck/node_modules/unified/index.js:369:11)
at next (/home/vignesh/Documents/master2/PET_Project/spellcheck/node_modules/trough/index.js:42:9)
at done (/home/vignesh/Documents/master2/PET_Project/spellcheck/node_modules/trough/wrap.js:55:16)
at done (/home/vignesh/Documents/master2/PET_Project/spellcheck/node_modules/unified/index.js:30:7)
at done (/home/vignesh/Documents/master2/PET_Project/spellcheck/node_modules/unified/index.js:300:11)
at next (/home/vignesh/Documents/master2/PET_Project/spellcheck/node_modules/trough/index.js:42:9)
at done (/home/vignesh/Documents/master2/PET_Project/spellcheck/node_modules/trough/wrap.js:55:16)
at wrapped (/home/vignesh/Documents/master2/PET_Project/spellcheck/node_modules/trough/wrap.js:36:14)
at next (/home/vignesh/Documents/master2/PET_Project/spellcheck/node_modules/trough/index.js:57:24)

This problem can solved by the following changes in the index.js file retext-overuse in line no 96.

Change the file.warn to file.message in the index.js file of the module...

please change it and provide the new version ASAP.

Performance

Not sure how to address this. I guess this plugin is inherently less performant than the other retext plugins. I'm working on an atom plugin to run all the lint-style retext plugins on plaintext, and this plugin takes ages on a single line of text, where all the others combined is almost instant. Anything we can do to improve performance of this plugin increases its viability as a live linting tool. Thanks for the work on this, looks super cool.

file.warn is not a function

Using Readme example:

TypeError: file.warn is not a function
    at \node_modules\retext-overuse\index.js:96:32
    at visitor (\node_modules\nlcst-search\index.js:119:9)
    at overload (\node_modules\unist-util-visit\index.js:27:12)
    at one (\node_modules\unist-util-visit-parents\index.js:34:25)
    at all (\node_modules\unist-util-visit-parents\index.js:57:16)
    at one (\node_modules\unist-util-visit-parents\index.js:42:28)
    at all (\node_modules\unist-util-visit-parents\index.js:57:16)
    at one (node_modules\unist-util-visit-parents\index.js:42:28)
    at all (\node_modules\unist-util-visit-parents\index.js:57:16)
    at one (\node_modules\unist-util-visit-parents\index.js:42:28

Node: 12.9.1
retext-overuse: 1.1.1

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.