textlint-rule-terminology

termstextlint-rule-terminology

textlint rule to check correct terms spelling.

Installation

npm install textlint-rule-terminology

Usage

textlint --format pretty-error --rule terminology Readme.md

Configuration

By default the rule will check against my personal terminology. You can change it in your .textlintrc:

{
  "rules": {
    "terminology": {
      // List of terms
      "terms": {
        // Correct spelling: list of possible mistakes
        "frontend": ["front-end"],
        "site": ["website"]
      },
      // OR load terms from a file
      "terms": "~/terms.json",
      // OR load terms from npm
      "terms": "@johnsmith/terms"
    }
  }
}

Read more about configuring textlint.

Changelog

The changelog 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.