retext plugin to check for redundant acronyms (such as ATM machine
to ATM
).
This package is a unified (retext) plugin to check for redundant acronyms (such as ATM machine
to ATM
).
🙂 Fun fact: this is called
RAS syndrome
(redundant acronym syndrome syndrome
).
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.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install retext-redundant-acronyms
In Deno with esm.sh
:
import retextRedundantAcronyms from 'https://esm.sh/retext-redundant-acronyms@5'
In browsers with esm.sh
:
<script type="module"> import retextRedundantAcronyms from 'https://esm.sh/retext-redundant-acronyms@5?bundle' </script>
Say our document example.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
This package exports no identifiers. The default export is retextRedundantAcronyms
.
unified().use(retextRedundantAcronyms)
Check for redundant acronyms (such as ATM machine
to ATM
).
There are no parameters.
Transform (Transformer
).
Each message is emitted as a VFileMessage
on file
, with source
set to 'retext-redundant-acronyms'
, ruleId
to the lowercase acronym, actual
to the unexpected phrase, and expected
to suggestions.
This package is fully typed with TypeScript. It exports no additional types.
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.
retext-indefinite-article
— check if indefinite articles are used correctlyretext-repeated-words
— check for for
repeated wordsSee 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.
MIT © Titus Wormer
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4