retext-equality
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatretext plugin to check for possible insensitive, inconsiderate language.
Contents
* [`unified().use(retextEquality[, options])`](#unifieduseretextequality-options)
* [`Options`](#options)
What is this?
This package is a unified (retext) plugin to check for certain words that could be considered insensitive, or otherwise inconsiderate, in certain contexts.When should I use this?
You can opt-into this plugin when you’re dealing with your own text and want to check for potential mistakes.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install retext-equality
In Deno with
esm.sh
esmsh:import retextEquality from 'https://esm.sh/retext-equality@7'
In browsers with
esm.sh
esmsh:<script type="module">
import retextEquality from 'https://esm.sh/retext-equality@7?bundle'
</script>
Use
Say our documentexample.txt
contains:Now that the child elements are floated, obviously the parent element will collapse.
…and our module
example.js
contains:import retextEnglish from 'retext-english'
import retextEquality from 'retext-equality'
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(retextEquality)
.use(retextStringify)
.process(await read('example.txt'))
console.error(reporter(file))
…then running
node example.js
yields:example.txt
1:42-1:51 warning Unexpected potentially insensitive use of `obviously`, try not to use it obvious retext-equality
⚠ 1 warning
API
This package exports no identifiers. The default export isretextEquality
api-retext-equality.unified().use(retextEquality[, options])
Check potentially insensitive language.Parameters
options
(Options
api-options, optional)
— configuration
Returns
Transform (Transformer
unified-transformer).Options
Configuration (TypeScript type).Fields
ignore
(Array<string>
, optional)
— phrases *not* to warn about
binary
(boolean
, default:false
)
— whether to allow “he or she”, “garbagemen and garbagewomen”, and similar
Messages
Seerules.md
file-rules for a list of rules and how rules work.Each message is emitted as a
VFileMessage
vfile-message with source
set
to 'retext-equality'
, ruleId
to an id
from rules.md
file-rules,
actual
to the not ok phrase, and expected
to suggested phrases.
Some messages also contain a note
with extra info.Types
This package is fully typed with TypeScript. It exports the additional typeOptions
api-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-equality@^7
,
compatible with Node.js 16.Related
— Catch insensitive, inconsiderate writing
— Check passive voice
— Check for profane and vulgar wording
— Check phrases for simpler alternatives
Contributing
Seecontributing.md
contributing in retextjs/.github
health for ways
to get started.
See support.md
support 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.
To create new patterns, add them in the YAML files in the
data/
file-data
directory, and run npm install
and then npm test
to build everything.
Please see the current patterns for inspiration.
New English rules will automatically be added to rules.md
.When you are happy with the new rule, add a test for it in
test.js
file-test, and open a pull request.