isabella232 / retext-equality

Warn about possible insensitive, inconsiderate language with Retext

retext-equality

Warn about possible insensitive, inconsiderate language with retext.

Installation

npm:

npm install retext-equality

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

Usage

var retext = require('retext');
var equality = require('retext-equality');
var doc = 'His network was set up with a master and slave.';

retext().use(equality).process(doc, function (err, file) {
    if (err) throw err;
    console.log(file.messages.map(String));
    /*
     * [
     *   '1:1-1:4: `His` may be insensitive, use `Their`, `Theirs` instead',
     *   '1:31-1:37: `master` / `slave` may be insensitive, use `primary` / `replica` instead'
     * ]
     */
});

API

retext.use(equality)

Adds warnings for possible insensitive, inconsiderate language to processed virtual files.

Parameters

• equality — This plug-in.

License

MIT © Titus Wormer