retext-equality

Warn about possible insensitive, inconsiderate language with retext.

Installation

npm install retext-equality

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

Usage

var retext = require('retext');
var report = require('vfile-reporter');
var equality = require('retext-equality');

retext()
    .use(equality)
    .process([
        'His network was set up with a master and slave.'
    ].join('\n'), function (err, file) {
        console.log(report(file));
    });

Yields:

<stdin>
    1:1-1:4  warning  `His` may be insensitive, use `Their`, `Theirs`, `Them` instead           her-him
  1:31-1:37  warning  `master` / `slave` may be insensitive, use `primary` / `replica` instead  master-slave

⚠ 2 warnings

API

`retext.use(equality[, options])`

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

Parameters

equality — This plug-in;
options (Object?, optional):
- ignore (Array.<string>) — List of phrases to not warn about;
- noBinary (boolean, default: false) — Do not allow binary references. By default he is warned about unless it’s followed by something like or she or and she. When noBinary is true, both cases would be warned about.

Contributing

Thanks, contributions are greatly appreciated! 👍 If you add new patterns, add them in the YAML files in the script/ directory, and execute npm test to build everything. Please see the current patterns for inspiration.

eah13/retext-equality

retext-equality

Installation

Usage

API

`retext.use(equality[, options])`

Contributing

License