eslint-plugin-word-check

check word

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-word-check:

npm install eslint-plugin-word-check --save-dev

Usage

Add word-check to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "word-check"
    ]
}

Then configure the rules you want to use under the rules section.

{
    "rules": {
        "word-check/rule-name": 2
    }
}

Rules

TODO: Run eslint-doc-generator to generate the rules list.

Usage of 'sensitive-symbol-check' rule

{
    "rules": {
        "word-check/sensitive-symbol-check": [2, {
            "sensitiveSymbols": []
        }]
    }
}
// put the symbols you want to check into array sensitiveSymbols