retext-redundant-acronyms
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatretext plugin to check for redundant acronyms (such as
ATM machine
to ATM
).Contents
* [`unified().use(retextRedundantAcronyms)`](#unifieduseretextredundantacronyms)
What is this?
This package is a unified (retext) plugin to check for redundant acronyms (such asATM machine
to ATM
).🙂 Fun fact: this is called RAS syndrome
wiki-ras (`redundant acronym
syndrome syndrome`).
When should I use this?
You can opt-into this plugin when you’re dealing with content that might contain grammar mistakes, 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-redundant-acronyms
In Deno with
esm.sh
esmsh:import retextRedundantAcronyms from 'https://esm.sh/retext-redundant-acronyms@5'
In browsers with
esm.sh
esmsh:<script type="module">
import retextRedundantAcronyms from 'https://esm.sh/retext-redundant-acronyms@5?bundle'
</script>
Use
Say our documentexample.txt
contains:Where can I find an ATM machine?
…and our module
example.js
contains:import retextEnglish from 'retext-english'
import retextRedundantAcronyms from 'retext-redundant-acronyms'
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(retextRedundantAcronyms)
.use(retextStringify)
.process(await read('example.txt'))
console.error(reporter(file))
…then running
node example.js
yields:example.txt
1:21-1:32 warning Unexpected redundant `ATM machine`, expected `ATM` atm retext-redundant-acronyms
âš 1 warning
API
This package exports no identifiers. The default export isretextRedundantAcronyms
api-retext-redundant-acronyms.unified().use(retextRedundantAcronyms)
Check for redundant acronyms (such as ATM machine
to ATM
).Parameters
There are no parameters.Returns
Transform (Transformer
unified-transformer).Messages
Each message is emitted as aVFileMessage
vfile-message on file
, with
source
set to 'retext-redundant-acronyms'
, ruleId
to the lowercase
acronym, actual
to the unexpected phrase, and expected
to suggestions.Types
This package is fully typed with TypeScript. It exports no additional types.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-redundant-acronyms@^5
, compatible with Node.js 16.Related
— check if indefinite articles are used correctly
— check `for for` repeated words
Contribute
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.