unified

Project: retextjs/retext-simplify

Package: retext-simplify@7.1.0

  1. Dependents: 16
  2. retext plugin to check phrases for simpler alternatives
  1. unified 174
  2. plugin 137
  3. retext 37
  4. phrase 5
  5. simple 2
  6. simpler 2
  7. synonym 2
  8. alternative 2

retext-simplify

Build Coverage Downloads Size Sponsors Backers Chat

retext plugin to check phrases for simpler alternatives.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install retext-simplify

Use

Say we have the following file, example.txt:

You can utilize a shorter word.
Be advised, don’t do this.
That’s the appropriate thing to do.

…and our script, example.js, looks as follows:

import {readSync} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {retext} from 'retext'
import retextSimplify from 'retext-simplify'

const file = readSync('example.txt')

retext()
  .use(retextSimplify)
  .process(file)
  .then((file) => {
    console.error(reporter(file))
  })

Yields:

example.txt
   1:9-1:16  warning  Replace `utilize` with `use`                                utilize      retext-simplify
   2:1-2:11  warning  Remove `Be advised`                                         be-advised   retext-simplify
  3:12-3:23  warning  Replace `appropriate` with `proper`, `right`, or remove it  appropriate  retext-simplify

⚠ 3 warnings

API

This package exports no identifiers. The default export is retextSimplify.

unified().use(retextSimplify[, options])

Check phrases for simpler alternatives.

options.ignore

Phrases not to warn about (Array.<string> - ruleIds).

Messages

Each message is emitted as a VFileMessage on file, with the following fields:

message.source

Name of this plugin ('retext-simplify').

message.ruleId

Normalized not ok phrase (string, such as 'utilize').

message.actual

Current not ok phrase (string, such as 'Utilize').

message.expected

List of suggestions (Array.<string>, such as ['use']).

Contribute

See contributing.md in retextjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer