eslint-plugin-tsdoc-require

Ensures that all typescript exported types and classes have TSDoc comments

Installation

You'll first need to install ESLint:

1npm i eslint --save-dev

Next, install eslint-plugin-tsdoc-require:

1npm 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:

1{
2    "plugins": [
3        "tsdoc-require"
4    ]
5}

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

1{
2    "rules": {
3        "tsdoc-require/require": 2
4    }
5}

Rules

Name	Description
require	Ensures that all typescript exported types and classes have TSDoc comments