eslint-plugin-tsdoc-require v0.0.3

eslint-plugin-tsdoc-require

Ensures that all typescript exported types and classes have TSDoc comments

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-tsdoc-require:

npm install eslint-plugin-tsdoc-require --save-dev

Usage

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

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

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

{
    "rules": {
        "tsdoc-require/require": 2
    }
}

Rules