use tsdoc

Author: trim21

.eslintrc.js

@@ -19,14 +19,16 @@ module.exports = {
     sourceType: 'module',
     projectFolderIgnoreList: ['dist'],
   },
-  plugins: ['jsdoc', '@typescript-eslint', 'prettier', 'jest'],
+  plugins: ['jsdoc', 'tsdoc', '@typescript-eslint', 'prettier', 'jest'],
   rules: {
     'no-dupe-class-members': 'off', // Off due to conflict with typescript overload functions
     'prettier/prettier': ['error', {}, { usePrettierrc: true }],
     '@typescript-eslint/array-type': ['warn', { default: 'array-simple' }],
     '@typescript-eslint/return-await': 'off',
     'jsdoc/check-alignment': 'error',
     'jsdoc/check-indentation': 'error',
+    'jsdoc/no-types': 'error',
+    'tsdoc/syntax': 'error',
     '@typescript-eslint/space-before-function-paren': 0,
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/explicit-function-return-type': 'off',

.prettierrc

@@ -1,8 +1,12 @@
 {
+  "plugins": [
+    "prettier-plugin-jsdoc"
+  ],
   "singleQuote": true,
   "arrowParens": "always",
   "semi": false,
   "bracketSpacing": true,
   "trailingComma": "es5",
+  "tsdoc": true,
   "printWidth": 80
 }

package.json

@@ -88,11 +88,12 @@
     "eslint-config-standard-with-typescript": "^17.0.0",
     "eslint-plugin-import": "2",
     "eslint-plugin-jest": "^24.1.8",
-    "eslint-plugin-jsdoc": "^32.2.0",
+    "eslint-plugin-jsdoc": "^39.6.4",
     "eslint-plugin-node": "11",
     "eslint-plugin-prettier": "^3.1.4",
     "eslint-plugin-promise": "4",
     "eslint-plugin-standard": "5",
+    "eslint-plugin-tsdoc": "^0.2.17",
     "gzip-size": "^6.0.0",
     "jest": "^26.6.3",
     "jest-fetch-mock": "^3.0.3",
@@ -101,6 +102,7 @@
     "lint-staged": "11.1.2",
     "nodemon": "^2.0.16",
     "prettier": "^2.2.1",
+    "prettier-plugin-jsdoc": "^0.4.2",
     "pretty-bytes": "^5.6.0",
     "rollup": "^2.79.1",
     "rollup-plugin-terser": "^7.0.0",