migrated to tsdocs

.eslintrc.cjs

@@ -5,10 +5,9 @@ module.exports = {
     'plugin:@typescript-eslint/recommended',
     'prettier',
     'plugin:import/errors',
-    'plugin:jsdoc/recommended',
   ],
   parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint'],
+  plugins: ['@typescript-eslint', 'eslint-plugin-tsdoc', 'jsdoc'],
   root: true,
   env: {
     es6: true,
@@ -35,5 +34,17 @@ module.exports = {
     ],
     'import/no-unresolved': ['error'],
     'no-undef': ['error'],
+    'tsdoc/syntax': 'error',
+    'require-jsdoc': 'error',
+    /// TODO: https://github.com/microsoft/tsdoc/issues/209
+    'jsdoc/require-param': 'error',
+    'jsdoc/require-param-description': 'error',
+    'jsdoc/require-description': 'error',
+    'jsdoc/require-param-name': 'error',
+    'jsdoc/require-throws': 'error',
+    'jsdoc/no-bad-blocks': 'error',
+    'jsdoc/empty-tags': 'error',
+    'jsdoc/require-jsdoc': 'error',
+    'jsdoc/check-syntax': 1,
   },
 };

.github/workflows/deploy_docs.yml

@@ -29,7 +29,7 @@ jobs:
       - name: Install
         run: yarn install
       - name: Build
-        run: npx typedoc --plugin typedoc-plugin-missing-exports
+        run: yarn docs
       - name: Setup Pages
         uses: actions/configure-pages@v3
       - name: Upload artifact

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-yarn lint-staged
+yarn lint-staged --

.lintstagedrc.cjs

@@ -1,4 +1,4 @@
 module.exports = {
-  '*.{cjs,js,ts,json,md}': 'yarn format',
-  '!*.{cjs,md}': 'yarn lint',
+  '*.{cjs,js,ts,json,md}': ['yarn format'],
+  '*.{cjs,md}': [() => 'yarn lint'],
 };

package.json

@@ -21,6 +21,7 @@
     "prepack": "pinst --disable",
     "postpack": "pinst --enable",
     "build": "rm -rf ./dist && tsc",
+    "docs": "typedoc",
     "test": "jest",
     "format": "yarn prettier . --write",
     "lint": "eslint . --fix"
@@ -34,15 +35,15 @@
     "eslint": "8.49.0",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-import": "2.28.1",
-    "eslint-plugin-jsdoc": "46.8.0",
+    "eslint-plugin-jsdoc": "^46.8.1",
+    "eslint-plugin-tsdoc": "0.2.17",
     "husky": "8.0.3",
     "jest": "29.7.0",
     "lint-staged": "14.0.1",
     "pinst": "3.0.0",
     "prettier": "3.0.3",
     "ts-jest": "29.1.1",
     "typedoc": "0.25.1",
-    "typedoc-plugin-missing-exports": "2.1.0",
     "typescript": "5.2.2"
   },
   "dependencies": {