retext-intensify
retext plugin to check for weak and mitigating wording.
Contents
What is this?
This package is a unified (retext) plugin to check for words that are weak: weasels, hedges, and fillers.
When should I use this?
You can opt-into this plugin when you’re dealing with content that might contain vague wording, 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-intensify
In Deno with esm.sh
:
import retextIntensify from 'https://esm.sh/retext-intensify@6'
In browsers with esm.sh
:
<script type="module">
import retextIntensify from 'https://esm.sh/retext-intensify@6?bundle'
</script>
Use
Say our document example.txt
contains:
Some people say there are quite some
problems, apparently.
…and our module example.js
looks as follows:
import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {retext} from 'retext'
import retextIntensify from 'retext-intensify'
cosnt file = await retext()
.use(retextIntensify)
.process(await read('example.txt'))
console.error(reporter(file))
…now running node example.js
yields:
example.txt
1:1-1:5 warning Don’t use `Some`, it’s vague or ambiguous weasel retext-intensify
1:13-1:16 warning Don’t use `say`, it lessens impact hedge retext-intensify
1:27-1:32 warning Don’t use `quite`, it’s vague or ambiguous weasel retext-intensify
1:33-1:37 warning Don’t use `some`, it’s vague or ambiguous weasel retext-intensify
2:11-2:21 warning Don’t use `apparently`, it doesn’t add meaning filler retext-intensify
⚠ 5 warnings
API
This package exports no identifiers. The default export is retextIntensify
.
unified().use(retextIntensify[, options])
Check for weak and mitigating wording.
options
Configuration (optional).
options.ignore
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-intensify'
).
message.ruleId
Category of warning ('filler'
, 'hedge'
, or 'weasel'
)
message.actual
Current not ok phrase (string
).
message.expected
Empty array to signal that actual
should be removed ([]
).
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 languageretext-passive
— check passive voiceretext-profanities
— check profane and vulgar wordingprofanities
— list of profane wordshedges
— list of hedge wordsfillers
— list of filler wordsweasels
— list of weasel words
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.