Skip to content

sapegin/textlint-rule-diacritics

Repository files navigation

textlint-rule-diacritics

textlint fixable rule npm Node.js CI status

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

Washing your code. A book on clean code for frontend developers

Installation

npm install textlint-rule-diacritics

Usage

textlint --fix --rule diacritics Readme.md

Configuration

You can configure the rule in your .textlintrc:

{
  "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. Read more about configuring textlint.

Other textlint rules

Change log

The change log can be found on the Releases page.

Contributing

Bug fixes are welcome, but not new features. Please take a moment to review the contributing guidelines.

Sponsoring

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

Buy Me A Coffee

Authors and license

Artem Sapegin and contributors.

MIT License, see the included License.md file.

Inspired by retext-diacritics.

Dictionary source: Wiktionary.