eslint-plugin-verify-tsdoc v1.0.20

eslint-plugin-verify-tsdoc

Ensures that all typescript exported types and classes have valid TSDoc comments.

This is a small hack using the index.js from eslint-plugin-tsdoc to intercept and ignore the 'tsdoc-param-tag-with-invalid-name' messages which are detected in @microsoft/tsDoc library.

Also based on some code from https://gist.github.com/nbouvrette/ f2c90316533e5a6c1f7702e35e4a586a to verify typeDoc parms match the function definition.

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-verify-tsdoc:

npm install pick68/eslint-plugin-verify-tsdoc --save-dev

Usage

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

{
    "plugins": [
        "@pick68/verify-tsdoc"
    ]
}

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

{
    "rules": {
        "@pick68/verify-tsdoc": "error"
    }
}