eslint-plugin-doc-doctor

Helps you write better JS docs

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-doc-doctor:

$ npm install eslint-plugin-doc-doctor --save-dev

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

Usage

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

{
    "plugins": [
        "doc-doctor"
    ]
}

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

{
    "rules": {
        "doc-doctor/rule-name": 2
    }
}

Supported Rules

• Fill in provided rules here