unified

Project: retextjs/retext-indefinite-article

Package: retext-indefinite-article@4.1.0

  1. Dependents: 0
  2. retext plugin to check if indefinite articles (a, an) are used correctly
  1. unified 179
  2. plugin 138
  3. retext 42
  4. retext-plugin 26
  5. article 2

retext-indefinite-article

Build Coverage Downloads Size Sponsors Backers Chat

retext plugin to check indefinite articles.

Contents

What is this?

This package is a unified (retext) plugin to check indefinite articles (a and an). It’s more complex than checking vowels, as it has to do with sounds. Knows about how digits are pronounced as well.

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. In Node.js (version 12.20+, 14.14+, 16.0+, or 18.0+), install with npm:

npm install retext-indefinite-article

In Deno with esm.sh:

import retextIndefiniteArticle from 'https://esm.sh/retext-indefinite-article@4'

In browsers with esm.sh:

<script type="module">
  import retextIndefiniteArticle from 'https://esm.sh/retext-indefinite-article@4?bundle'
</script>

Use

Say our document example.txt contains:

He should, a 8-year old boy, should have arrived a hour
ago on an European flight.  An historic event, or a
historic event? Both are fine.

…and our module example.js looks as follows:

import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {unified} from 'unified'
import retextEnglish from 'retext-english'
import retextIndefiniteArticle from 'retext-indefinite-article'
import retextStringify from 'retext-stringify'

const file = await unified()
  .use(retextEnglish)
  .use(retextIndefiniteArticle)
  .use(retextStringify)
  .process(await read('example.txt'))

console.error(reporter(file))

…now running node example.js yields:

example.txt
  1:12-1:13  warning  Use `an` before `8-year`, not `a`    retext-indefinite-article  retext-indefinite-article
  1:50-1:51  warning  Use `an` before `hour`, not `a`      retext-indefinite-article  retext-indefinite-article
   2:8-2:10  warning  Use `a` before `European`, not `an`  retext-indefinite-article  retext-indefinite-article

⚠ 3 warnings

API

This package exports no identifiers. The default export is retextIndefiniteArticle.

unified().use(retextIndefiniteArticle)

Check indefinite articles.

There are no options.

Messages

Each message is emitted as a VFileMessage on file, with the following fields:

message.source

Name of this plugin ('retext-indefinite-article').

message.ruleId

Name of this plugin ('retext-indefinite-article').

message.actual

Current not ok word (string, 'a' or 'an').

message.expected

Array with one value (Array<string>, containing either 'a' or 'an').

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.

Contribute

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

License

MIT © Titus Wormer