chore: add tsdoc linting

Author: JulianCataldo

.editorconfig

@@ -7,7 +7,7 @@ indent_style = space
 indent_size = 2
 end_of_line = lf
 charset = utf-8
-trim_trailing_whitespace = false # FIX: disabled for markdown in TSDoc comments
+trim_trailing_whitespace = false
 insert_final_newline = true
 
 [**/Makefile]

configs/.editorconfig

@@ -7,7 +7,7 @@ indent_style = space
 indent_size = 2
 end_of_line = lf
 charset = utf-8
-trim_trailing_whitespace = true
+trim_trailing_whitespace = false # FIXME: disabled for markdown in TSDoc comments
 insert_final_newline = true
 
 [**/Makefile]

configs/.eslintrc.cjs

@@ -16,8 +16,11 @@ module.exports = {
     // 'plugin:prettier/recommended',
   ],
 
+  plugins: ['eslint-plugin-tsdoc'],
+
   rules: {
     'no-restricted-syntax': 0,
+    'tsdoc/syntax': 'warn',
     // 'import/extensions': ['error', 'always'],
     // 'prettier/prettier': ['error'],
   },

package.json

@@ -42,6 +42,7 @@
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-react": "^7.30.0",
     "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-tsdoc": "^0.2.16",
     "eslint-plugin-vue": "^9.1.1",
     "husky": "^8.0.1",
     "lerna": "^5.1.4",