eslint-plugin-require-docs

An ESLint plugin to require code documentation

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-require-docs:

$ npm install eslint-plugin-require-docs --save-dev

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

Usage

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

{
  "plugins": ["require-docs"]
}

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

{
  "rules": {
    "require-docs/rule-name": 2
  }
}

Supported Rules

• flow-types: Require documentation for Flow type declarations