Textlint rule to check correct usage of diacritics
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.editorconfig
.eslintignore
.eslintrc
.gitignore
.npmignore
.travis.yml
Contributing.md
License.md
Readme.md
index.js
package.json
test.js
words.json
yarn.lock

Readme.md

textlint-rule-diacritics

textlint fixable rule Build Status npm

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

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

Everyone is welcome to contribute. Please take a moment to review the contributing guidelines.

Authors and license

Artem Sapegin and contributors.

MIT License, see the included License.md file.

Inspired by retext-diacritics.

Dictionary source: Wiktionary.