chore: enable eslint-plugin-jsdoc (#400)

Co-authored-by: Shinigami <[email protected]>

.eslintrc.js

@@ -50,6 +50,27 @@ module.exports = defineConfig({
     '@typescript-eslint/unbound-method': 'warn',
   },
   overrides: [
+    {
+      files: ['src/**/*.ts'],
+      plugins: ['jsdoc'],
+      extends: ['plugin:jsdoc/recommended'],
+      rules: {
+        'jsdoc/no-types': 'error',
+        'jsdoc/require-param-type': 'off',
+        'jsdoc/require-returns-type': 'off',
+        'jsdoc/require-returns': 'off',
+        'jsdoc/tag-lines': 'off',
+
+        // Rule will come in one of the next releases: https://github.com/gajus/eslint-plugin-jsdoc/pull/833
+        // We want to explicitly set this rule to error in the future
+        // 'jsdoc/sort-tags': 'warn',
+      },
+      settings: {
+        jsdoc: {
+          mode: 'typescript',
+        },
+      },
+    },
     {
       files: ['test/*.spec.ts'],
       rules: {

package.json

@@ -87,7 +87,7 @@
     ]
   },
   "devDependencies": {
-    "@types/node": "~16.11.21",
+    "@types/node": "~16.11.22",
     "@typescript-eslint/eslint-plugin": "~5.10.2",
     "@typescript-eslint/parser": "~5.10.2",
     "@types/prettier": "~2.4.3",
@@ -99,6 +99,7 @@
     "esbuild": "~0.14.18",
     "eslint-define-config": "~1.2.3",
     "eslint-gitignore": "~0.1.0",
+    "eslint-plugin-jsdoc": "~37.7.1",
     "eslint": "~8.8.0",
     "esno": "~0.14.0",
     "lint-staged": "~12.3.3",