Install and Enable TSDoc linter
On the in-person 2023 meeting the team have agreed to follow the TSDoc style for documenting the typescript code. Having said that, we need a linter to validate the documentation formatting. To do it:
npm install --save-dev eslint-plugin-tsdoc
Then, update the .eslintrc.json
with the following contents:
"plugins": ["eslint-plugin-tsdoc"],
"rules": {
"tsdoc/syntax": "warn"
},
Finally, correct the issues reported by the linter. Most of the errors seem to be related to not using a hyphen after function parameter names (tsdoc-param-tag-missing-hyphen
).