https://github.com/sapegin/textlint-rule-diacritics

Textlint rule to check correct usage of diacritics
https://github.com/sapegin/textlint-rule-diacritics

diacritics textlint textlintrule

Last synced: 3 months ago
JSON representation

Textlint rule to check correct usage of diacritics

• Host: GitHub
• URL: https://github.com/sapegin/textlint-rule-diacritics
• Owner: sapegin
• License: mit
• Created: 2017-05-13T20:17:12.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-10-30T08:03:20.000Z (7 months ago)
• Last Synced: 2025-03-12T11:05:56.301Z (3 months ago)
• Topics: diacritics, textlint, textlintrule
• Language: TypeScript
• Homepage:
• Size: 204 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • Contributing: Contributing.md
  • License: License.md

Awesome Lists containing this project

README

        
# textlint-rule-diacritics

[![textlint fixable rule](https://img.shields.io/badge/textlint-fixable-green.svg?style=social)](https://textlint.github.io/) [![npm](https://img.shields.io/npm/v/textlint-rule-diacritics.svg)](https://www.npmjs.com/package/textlint-rule-diacritics) [![Node.js CI status](https://github.com/sapegin/textlint-rule-diacritics/workflows/Node.js%20CI/badge.svg)](https://github.com/sapegin/textlint-rule-diacritics/actions)

[Textlint](https://github.com/textlint/textlint) rule to check and fix the correct usage of diacritics.

For example:

- creme brulee → crème brûlée

- deja vu → déjà vu

- senorita → señorita

- doppelganger → doppelgänger

(You can add your own words too.)

![](https://d3vv6lp55qjaqc.cloudfront.net/items/2U143Z0i3p3G0i1Q0i1D/textlint-rule-diacritics.png)

[![Washing your code. A book on clean code for frontend developers](https://sapegin.me/images/washing-code-github.jpg)](https://sapegin.me/book/)

## Installation

```shell

npm install textlint-rule-diacritics

```

## Usage

```shell

textlint --fix --rule diacritics Readme.md

```

## Configuration

You can configure the rule in your `.textlintrc`:

```js

{

  "rules": {

    "diacritics": {

      // List of additional words

      "words": [

        "tâmia",

      ],

      // OR load words from a file

      "words": "~/words.json",

      // OR load words from npm

      "words": "@johnsmith/words"

    }

  }

}

```

Check [the default diacritics list](./words.json). Read more about [configuring textlint](https://github.com/textlint/textlint/blob/master/docs/configuring.md).

## Other textlint rules

- [textlint-rule-apostrophe](https://github.com/sapegin/textlint-rule-apostrophe) — correct apostrophe usage

- [textlint-rule-stop-words](https://github.com/sapegin/textlint-rule-stop-words) — filler words, buzzwords and clichés

- [textlint-rule-terminology](https://github.com/sapegin/textlint-rule-terminology) — correct terms spelling

## Change log

The change log can be found on the [Releases page](https://github.com/sapegin/textlint-rule-diacritics/releases).

## Contributing

Bug fixes are welcome, but not new features. Please take a moment to review the [contributing guidelines](Contributing.md).

## Sponsoring

This software has been developed with lots of coffee, buy me one more cup to keep it going.



## Authors and license

[Artem Sapegin](https://sapegin.me) and [contributors](https://github.com/sapegin/textlint-rule-diacritics/graphs/contributors).

MIT License, see the included [License.md](License.md) file.

Inspired by [retext-diacritics](https://github.com/wooorm/retext-diacritics).

Dictionary source: [Wiktionary](https://en.wiktionary.org/wiki/Appendix:English_words_with_diacritics).