retext-simplify

retext plugin to check for simpler alternatives.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • unified().use(retextSimplify[, options])
• Messages
• Types
• Compatibility
• Related
• Contribute
• License

What is this?

This package is a unified (retext) plugin to check for simpler alternatives. For example it suggest use instead of utilize.

When should I use this?

You can opt-into this plugin when you’re dealing with content that might contain overlong words or phrases, and have authors that can fix that content.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, or 18.0+), install with npm:

npm install retext-simplify

In Deno with esm.sh:

import retextSimplify from 'https://esm.sh/retext-simplify@7'

In browsers with esm.sh:

<script type="module">
  import retextSimplify from 'https://esm.sh/retext-simplify@7?bundle'
</script>

Use

Say our document example.txt contains:

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

…and our module example.js looks as follows:

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

const file = await retext()
  .use(retextSimplify)
  .process(await read('example.txt'))

console.error(reporter(file))

…now running node example.js 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 for simpler alternatives.

options

Configuration (optional).

options.ignore

ruleId of phrases not to warn about (Array<string>).

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']).

Types

This package is fully typed with TypeScript. It exports the additional type Options.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.

Related

• retext-equality — check possible insensitive, inconsiderate language
• retext-intensify — check for weak and mitigating wording
• retext-passive — check passive voice
• retext-profanities — check profane and vulgar wording

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