retext-redundant-acronyms

retext plugin to check for redundant acronyms (ATM machine)

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
retext-redundant-acronyms
5.0.03 months ago7 years agoMinified + gzip package size for retext-redundant-acronyms in KB

Readme

retext-redundant-acronyms
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
retext 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 as ATM machine to ATM).
🙂 Fun fact: this is called RAS syndromewiki-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.shesmsh:
import retextRedundantAcronyms from 'https://esm.sh/retext-redundant-acronyms@5'

In browsers with esm.shesmsh:
<script type="module">
  import retextRedundantAcronyms from 'https://esm.sh/retext-redundant-acronyms@5?bundle'
</script>

Use

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

API

This package exports no identifiers. The default export is retextRedundantAcronymsapi-retext-redundant-acronyms.

unified().use(retextRedundantAcronyms)

Check for redundant acronyms (such as ATM machine to ATM).
Parameters
There are no parameters.
Returns
Transform (Transformerunified-transformer).

Messages

Each message is emitted as a VFileMessagevfile-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

See contributing.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.

License

MITlicense © Titus Wormerauthor