retext-diacritics

[![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 proper use of diacritics.

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

``sh npm install retext-diacritics`

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

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

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

`html`

`Use`

Say our document example.txt contains:

`txt Beyonce is the creme fresh on his resume.`

…and our module example.js contains:

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

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

⚠ 3 warnings`

`API`

This package exports no identifiers. The default export is [retextDiacritics][api-retext-diacritics].

`$3`

Check for proper use of diacritics.

###### Parameters

There are no parameters.

###### Returns

Transform ([Transformer][unified-transformer]).

`Messages`

The following [VFileMessage][vfile-message]s 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— checkfor forrepeated words *retext-sentence-spacing— check spacing (one or two spaces) between sentences *retext-quotes— check quote and apostrophe usage

`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-diacritics/workflows/main/badge.svg

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

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

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

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

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

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

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

[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

[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-diacritics]: #unifieduseretextdiacritics

retext-diacritics

[retext][] plugin to check for proper use of diacritics.

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

``sh npm install retext-diacritics`

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

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

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

`html`

`Use`

Say our document example.txt contains:

`txt Beyonce is the creme fresh on his resume.`

…and our module example.js contains:

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:

⚠ 3 warnings`

`API`

This package exports no identifiers. The default export is [retextDiacritics][api-retext-diacritics].

`$3`

Check for proper use of diacritics.

###### Parameters

There are no parameters.

###### Returns

Transform ([Transformer][unified-transformer]).

`Messages`

The following [VFileMessage][vfile-message]s 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`

`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

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

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

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

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

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

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

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

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

[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

[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-diacritics]: #unifieduseretextdiacritics

retext-diacritics

retext-diacritics

Contents

What is this?

When should I use this?

Install

`Use`

`API`

`$3`

`Messages`

`Types`

`Compatibility`

`Related`

`Contribute`

License

retext-diacritics

retext-diacritics

Contents

What is this?

When should I use this?

Install

`Use`

`API`

`$3`

`Messages`

`Types`

`Compatibility`

`Related`

`Contribute`

License