eslint-plugin-ei

eslint rules for ei

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-ei:

npm install eslint-plugin-ei --save-dev

Usage

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

{
    "plugins": [
        "ei"
    ]
}

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

{
    "rules": {
      "ei/add-function-comment": ["warn", {
        "require": {
          // Default configuration
          "FunctionExpression": true,
          "MethodDefinition": true,
          "ArrowFunctionExpression": true,
          "FunctionDeclaration": true,
          "skipComments": true,
          "skipBlankLines": true,
          "minLineCountForComments": 30,
        },
      }]
    }
}

Supported Rules

• Fill in provided rules here