Added JSDoc to ESLint (#3529)

* Added JSDoc to eslint rules

Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com>

* Fixed JSDoc eslint errors

Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com>

* Update the check-linters workflow to Node.js 20

---------

Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com>
Co-authored-by: Louis Lam <louislam@users.noreply.github.com>

.eslintrc.js

@@ -14,6 +14,7 @@ module.exports = {
     extends: [
         "eslint:recommended",
         "plugin:vue/vue3-recommended",
+        "plugin:jsdoc/recommended-error",
     ],
     parser: "vue-eslint-parser",
     parserOptions: {
@@ -21,6 +22,9 @@ module.exports = {
         sourceType: "module",
         requireConfigFile: false,
     },
+    plugins: [
+        "jsdoc"
+    ],
     rules: {
         "yoda": "error",
         eqeqeq: [ "warn", "smart" ],
@@ -97,7 +101,42 @@ module.exports = {
         }],
         "no-control-regex": "off",
         "one-var": [ "error", "never" ],
-        "max-statements-per-line": [ "error", { "max": 1 }]
+        "max-statements-per-line": [ "error", { "max": 1 }],
+        "jsdoc/check-tag-names": [
+            "error",
+            {
+                "definedTags": [ "link" ]
+            }
+        ],
+        "jsdoc/no-undefined-types": "off",
+        "jsdoc/no-defaults": [
+            "error",
+            { "noOptionalParamNames": true }
+        ],
+        "jsdoc/require-throws": "error",
+        "jsdoc/require-jsdoc": [
+            "error",
+            {
+                "require": {
+                    "FunctionDeclaration": true,
+                    "MethodDefinition": true,
+                }
+            }
+        ],
+        "jsdoc/no-blank-block-descriptions": "error",
+        "jsdoc/require-returns-check": [
+            "error",
+            { "reportMissingReturnForUndefinedTypes": false }
+        ],
+        "jsdoc/require-returns": [
+            "error",
+            {
+                "forceRequireReturn": true,
+                "forceReturnsWithAsync": true
+            }
+        ],
+        "jsdoc/require-param-type": "error",
+        "jsdoc/require-param-description": "error"
     },
     "overrides": [
         {