/eslint-plugin-sentence-case

ESLint plugin to enforce sentence case in string literals

Primary LanguageJavaScript

eslint-plugin-sentence-case

Enforce that string literals are in sentence case.

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-sentence-case:

$ npm install eslint-plugin-sentence-case --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-sentence-case globally.

Usage

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

{
    "plugins": [
        "sentence-case"
    ]
}

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

{
    "rules": {
        "sentence-case/rule-name": 2
    }
}

Supported Rules