Ensures that all typescript exported types and classes have TSDoc comments
npm install eslint-plugin-tsdoc-requireEnsures that all typescript exported types and classes have TSDoc comments
You'll first need to install ESLint:
``sh`
npm i eslint --save-dev
Next, install eslint-plugin-tsdoc-require:
`sh`
npm install eslint-plugin-tsdoc-require --save-dev
Add tsdoc-require to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:
`json`
{
"plugins": [
"tsdoc-require"
]
}
Then configure the rules you want to use under the rules section.
`json``
{
"rules": {
"tsdoc-require/require": 2
}
}
| Name | Description |
| :------------------------------- | :------------------------------------------------------------------------- |
| require | Ensures that all typescript exported types and classes have TSDoc comments |