Add jsdoc linting (#1513)

Author: gkjohnson

eslint.config.js

@@ -5,6 +5,7 @@ import react from 'eslint-plugin-react';
 import reactHooks from 'eslint-plugin-react-hooks';
 import globals from 'globals';
 import mdcs from 'eslint-config-mdcs';
+import jsdoc from 'eslint-plugin-jsdoc';
 
 export default [
 	// files to ignore
@@ -99,6 +100,38 @@ export default [
 		},
 	},
 
+	// jsdoc
+	{
+		name: 'jsdoc rules',
+		files: [ '**/*.js', '**/*.jsx' ],
+		plugins: {
+			jsdoc,
+		},
+		settings: {
+			jsdoc: {
+				preferredTypes: {
+					Any: 'any',
+					Boolean: 'boolean',
+					Number: 'number',
+					object: 'Object',
+					String: 'string',
+				},
+				tagNamePreference: {
+					returns: 'return',
+					extends: 'augments',
+				},
+			},
+		},
+		rules: {
+			'jsdoc/check-types': 'error',
+			'jsdoc/require-param-type': 'error',
+			'jsdoc/require-returns-type': 'error',
+			'jsdoc/require-returns': 'off',
+			'jsdoc/require-param-description': 'off',
+			'jsdoc/require-returns-description': 'off',
+		},
+	},
+
 	// vitest
 	{
 		name: 'vitest rules',

package-lock.json

@@ -100,6 +100,7 @@
     "concurrently": "^6.2.1",
     "eslint": "^9.0.0",
     "eslint-config-mdcs": "^5.0.0",
+    "eslint-plugin-jsdoc": "^62.8.0",
     "eslint-plugin-react": "^7.37.1",
     "eslint-plugin-react-hooks": "^5.0.0",
     "globals": "^16.5.0",