retext-simplify
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatretext plugin to check for simpler alternatives.
Contents
* [`unified().use(retextSimplify[, options])`](#unifieduseretextsimplify-options)
* [`Options`](#options)What is this?
This package is a unified (retext) plugin to check for simpler alternatives. For example it suggestuse 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 onlyesm. In Node.js (version 16+), install with npm:npm install retext-simplifyIn Deno with
esm.shesmsh:import retextSimplify from 'https://esm.sh/retext-simplify@8'In browsers with
esm.shesmsh:<script type="module">
import retextSimplify from 'https://esm.sh/retext-simplify@8?bundle'
</script>Use
Say our documentexample.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 {retext} from 'retext'
import retextSimplify from 'retext-simplify'
import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
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 Unexpected `utilize`, use `use` instead utilize retext-simplify
2:1-2:11 warning Unexpected `Be advised`, remove it be-advised retext-simplify
3:12-3:23 warning Unexpected `appropriate`, remove it, or use `proper`, `right` instead appropriate retext-simplify
⚠ 3 warningsAPI
This package exports no identifiers. The default export isretextSimplifyapi-retext-simplify.unified().use(retextSimplify[, options])
Check for simpler alternatives.Parameters
options(Optionsapi-options, optional)
— configurationReturns
Transform (Transformerunified-transformer).Options
Configuration (TypeScript type).Fields
ignore(Array<string>, optional)
— phrases *not* to warn aboutMessages
Each message is emitted as aVFileMessagevfile-message on file, with
source set to 'retext-simplify', ruleId to the normalized phrase,
actual to the unexpected phrase, and expected to suggestions.Types
This package is fully typed with TypeScript. It exports the additional typeOptionsapi-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-simplify@^8,
compatible with Node.js 16.Related
— check possible insensitive, inconsiderate language— check for weak and mitigating wording— check passive voice— check profane and vulgar wordingContribute
Seecontributing.mdcontributing in retextjs/.githubhealth for ways
to get started.
See support.mdsupport for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.
