Nimble Pirate Monitor

    textlint-rule-diacritics

    1.0.0 • Public • Published

    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.

    Install

    npm i textlint-rule-diacritics

    DownloadsWeekly Downloads

    2,600

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    11.1 kB

    Total Files

    5

    Last publish

    Collaborators

    • sapegin