retextjs / retext-passive

plugin to check for passive voice

retext-passive

retext plugin to check for passive voice.

Contents

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

What is this?

This package is a unified (retext) plugin to check for the passive voice. It checks for certain verbs ('am', 'are', 'were', 'being', 'is', 'been', 'was', or 'be'), followed by a word in list.js.

When should I use this?

You can opt-into this plugin when you’re dealing with content that might contain weak language, and have authors that can fix that content.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install retext-passive

In Deno with esm.sh:

import retextPassive from 'https://esm.sh/retext-passive@5'

In browsers with esm.sh:

<script type="module">
  import retextPassive from 'https://esm.sh/retext-passive@5?bundle'
</script>

Use

Say our document example.txt contains:

He was withheld while we were being fed.

…and our module example.js contains:

import retextEnglish from 'retext-english'
import retextPassive from 'retext-passive'
import retextStringify from 'retext-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'

const file = await unified()
  .use(retextEnglish)
  .use(retextPassive)
  .use(retextStringify)
  .process(await read('example.txt'))

console.error(reporter(file))

…then running node example.js yields:

example.txt
1:8-1:16  warning Unexpected use of the passive voice withheld retext-passive
1:37-1:40 warning Unexpected use of the passive voice fed      retext-passive

⚠ 2 warnings

API

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

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

Check for the passive voice.

Parameters

• options (Options, optional) — configuration

Returns

Transform (Transformer).

Options

Configuration (TypeScript type).

Fields

• ignore (Array<string>, optional) — phrases not to warn about

Messages

Each message is emitted as a VFileMessage on file, with source set to 'retext-passive', ruleId to any word in list.js, actual to the unexpected phrase, and expected to an empty array.

Types

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

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, retext-passive@^5, compatible with Node.js 16.

Related

• retext-equality — check possible insensitive, inconsiderate language
• retext-profanities — check for profane and vulgar wording
• retext-simplify — check phrases for simpler alternatives

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