retext-diacritics

retext plugin to check for proper use of diacritics.

Contents

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

What is this?

This package is a unified (retext) plugin to check for certain words that should have diacritics, such as Beyonce -> Beyoncé.

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 16+), install with npm:

npm install retext-diacritics

In Deno with esm.sh:

import retextDiacritics from 'https://esm.sh/retext-diacritics@5'

In browsers with esm.sh:

<script type="module">
  import retextDiacritics from 'https://esm.sh/retext-diacritics@5?bundle'
</script>

Use

Say our document example.txt contains:

Beyonce is the creme fresh on his resume.

…and our module example.js contains:

import retextDiacritics from 'retext-diacritics'
import retextEnglish from 'retext-english'
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(retextDiacritics)
  .use(retextStringify)
  .process(await read('example.txt'))

console.error(reporter(file))

…then running node example.js yields:

example.txt
1:1-1:8   warning Unexpected undiacritical `Beyonce`, did you mean `Beyoncé`           beyonce     retext-diacritics
1:16-1:27 warning Unexpected undiacritical `creme fresh`, did you mean `crème fraîche` creme-fresh retext-diacritics
1:31-1:41 warning Unexpected undiacritical `his resume`, did you mean `his résumé`     his-resume  retext-diacritics

⚠ 3 warnings

API

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

unified().use(retextDiacritics)

Check for proper use of diacritics.

Parameters

There are no parameters.

Returns

Transform (Transformer).

Messages

The following VFileMessages are used:

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-diacritics@^5, compatible with Node.js 16.

Related

• retext-contractions — check apostrophe use in contractions
• retext-indefinite-article — check if indefinite articles (a, an) are used correctly
• retext-redundant-acronyms — check for redundant acronyms (ATM machine)
• retext-repeated-words — check for for repeated words
• retext-sentence-spacing — check spacing (one or two spaces) between sentences
• retext-quotes — check quote and apostrophe usage

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