retext-redundant-acronyms

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]

[retext][] plugin to check for redundant acronyms (such as ATM machine
to ATM).

Contents

* What is this?
* When should I use this?
* Install
* Use
* API
* unified().use(retextRedundantAcronyms)
* Messages
* Types
* Compatibility
* Related
* Contribute
* License

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 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 only][esm].
In Node.js (version 16+), install with [npm][]:

``sh
npm install retext-redundant-acronyms
`

In Deno with [esm.sh][esmsh]:

`js
import retextRedundantAcronyms from 'https://esm.sh/retext-redundant-acronyms@5'
`

In browsers with [esm.sh][esmsh]:

`html

`

Use

Say our document example.txt contains:

`txt
Where can I find an ATM machine?
`

…and our module example.js contains:

`js
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:

`text
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
[retextRedundantAcronyms][api-retext-redundant-acronyms].

$3

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 a [VFileMessage][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

* retext-indefinite-article
— check if indefinite articles are used correctly
* retext-repeated-words
— check for for repeated words

Contribute

See [contributing.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 conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.

License

[MIT][license] © [Titus Wormer][author]

[build-badge]: https://github.com/retextjs/retext-redundant-acronyms/workflows/main/badge.svg

[build]: https://github.com/retextjs/retext-redundant-acronyms/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/retextjs/retext-redundant-acronyms.svg

[coverage]: https://codecov.io/github/retextjs/retext-redundant-acronyms

[downloads-badge]: https://img.shields.io/npm/dm/retext-redundant-acronyms.svg

[downloads]: https://www.npmjs.com/package/retext-redundant-acronyms

[size-badge]: https://img.shields.io/bundlejs/size/retext-redundant-acronyms

[size]: https://bundlejs.com/?q=retext-redundant-acronyms

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/retextjs/retext/discussions

[npm]: https://docs.npmjs.com/cli/install

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[esmsh]: https://esm.sh

[typescript]: https://www.typescriptlang.org

[health]: https://github.com/retextjs/.github

[contributing]: https://github.com/retextjs/.github/blob/main/contributing.md

[support]: https://github.com/retextjs/.github/blob/main/support.md

[coc]: https://github.com/retextjs/.github/blob/main/code-of-conduct.md

[license]: license

[author]: https://wooorm.com

[wiki-ras]: https://en.wikipedia.org/wiki/RAS_syndrome

[retext]: https://github.com/retextjs/retext

[unified]: https://github.com/unifiedjs/unified

[unified-transformer]: https://github.com/unifiedjs/unified#transformer

[vfile-message]: https://github.com/vfile/vfile-message

[api-retext-redundant-acronyms]: #unifieduseretextredundantacronyms