eslint-plugin-comment-english-please v0.0.4

eslint-plugin-comment-english-please

Please comment with english.

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-comment-english-please:

$ npm install eslint-plugin-comment-english-please --save-dev

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

Usage

Add comment-english-please to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "comment-english-please"
    ]
}

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

{
    "rules": {
        "comment-english-please/english-please": "warn"
    }
}

Supported Rules

• english-please

Good luck!!