feat: check tsdocs when using typescript

Author: RebeccaStevens

README.md

@@ -86,6 +86,7 @@ yarn add -D  \
   eslint-plugin-optimize-regex \
   eslint-plugin-promise \
   eslint-plugin-sonarjs \
+  eslint-plugin-tsdoc \
   eslint-plugin-unicorn
 ```
 

package.json

@@ -90,6 +90,7 @@
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-promise": "^6.0.0",
     "eslint-plugin-sonarjs": "^0.11.0",
+    "eslint-plugin-tsdoc": "^0.2.14",
     "eslint-plugin-unicorn": "^40.0.0",
     "husky": "^7.0.2",
     "lint-staged": "^12.1.4",
@@ -118,6 +119,7 @@
     "eslint-plugin-optimize-regex": "*",
     "eslint-plugin-promise": "*",
     "eslint-plugin-sonarjs": "*",
+    "eslint-plugin-tsdoc": "*",
     "eslint-plugin-unicorn": "*"
   },
   "engines": {

src/configs/typescript.ts

@@ -1,6 +1,7 @@
 import { deepmerge } from "deepmerge-ts";
 import type { Linter } from "eslint";
 
+import { settings as tsdoc } from "~/plugins/tsdoc";
 import { settings as typescript } from "~/plugins/typescript";
 
 const baseConfig: Linter.Config = {
@@ -45,4 +46,4 @@ const baseConfig: Linter.Config = {
   ],
 };
 
-export default deepmerge(baseConfig, typescript);
+export default deepmerge(baseConfig, typescript, tsdoc);

src/plugins/tsdoc.ts

@@ -0,0 +1,9 @@
+import type { Linter } from "eslint";
+
+export const settings: Linter.Config = {
+  plugins: ["tsdoc"],
+
+  rules: {
+    "tsdoc/syntax": "warn",
+  },
+};