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>
2025-08-11 11:44:19 +08:00 · 2023-08-11 09:46:41 +02:00
parent da4f4e3d76
commit 8a92054c2b
153 changed files with 1505 additions and 574 deletions
--- a/package-lock.json
+++ b/package-lock.json
@@ -103,6 +103,7 @@
                "dns2": "~2.0.1",
                "dompurify": "~2.4.3",
                "eslint": "~8.14.0",
+                "eslint-plugin-jsdoc": "^46.4.6",
                "eslint-plugin-vue": "~8.7.1",
                "favico.js": "~0.3.10",
                "jest": "~29.6.1",
@@ -3456,6 +3457,20 @@
                "ms": "^2.1.1"
            }
        },
+        "node_modules/@es-joy/jsdoccomment": {
+            "version": "0.40.1",
+            "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.40.1.tgz",
+            "integrity": "sha512-YORCdZSusAlBrFpZ77pJjc5r1bQs5caPWtAu+WWmiSo+8XaUzseapVrfAtiRFbQWnrBxxLLEwF6f6ZG/UgCQCg==",
+            "dev": true,
+            "dependencies": {
+                "comment-parser": "1.4.0",
+                "esquery": "^1.5.0",
+                "jsdoc-type-pratt-parser": "~4.0.0"
+            },
+            "engines": {
+                "node": ">=16"
+            }
+        },
        "node_modules/@esbuild/android-arm": {
            "version": "0.18.20",
            "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.18.20.tgz",
@@ -6227,6 +6242,15 @@
                }
            ]
        },
+        "node_modules/are-docs-informative": {
+            "version": "0.0.2",
+            "resolved": "https://registry.npmjs.org/are-docs-informative/-/are-docs-informative-0.0.2.tgz",
+            "integrity": "sha512-ixiS0nLNNG5jNQzgZJNoUpBKdo9yTYZMGJ+QgT2jmjR7G7+QHRCc4v6LQ3NgE7EBJq+o0ams3waJwkrlBom8Ig==",
+            "dev": true,
+            "engines": {
+                "node": ">=14"
+            }
+        },
        "node_modules/are-we-there-yet": {
            "version": "2.0.0",
            "resolved": "https://registry.npmjs.org/are-we-there-yet/-/are-we-there-yet-2.0.0.tgz",
@@ -6992,6 +7016,18 @@
                "node": ">=10.0.0"
            }
        },
+        "node_modules/builtin-modules": {
+            "version": "3.3.0",
+            "resolved": "https://registry.npmjs.org/builtin-modules/-/builtin-modules-3.3.0.tgz",
+            "integrity": "sha512-zhaCDicdLuWN5UbN5IMnFqNMhNfo919sH85y2/ea+5Yg9TsTkeZxpL+JLbp6cgYFS4sRLp3YV4S6yDuqVWHYOw==",
+            "dev": true,
+            "engines": {
+                "node": ">=6"
+            },
+            "funding": {
+                "url": "https://github.com/sponsors/sindresorhus"
+            }
+        },
        "node_modules/bulk-write-stream": {
            "version": "2.0.1",
            "resolved": "https://registry.npmjs.org/bulk-write-stream/-/bulk-write-stream-2.0.1.tgz",
@@ -7533,6 +7569,15 @@
                "node": ">= 6"
            }
        },
+        "node_modules/comment-parser": {
+            "version": "1.4.0",
+            "resolved": "https://registry.npmjs.org/comment-parser/-/comment-parser-1.4.0.tgz",
+            "integrity": "sha512-QLyTNiZ2KDOibvFPlZ6ZngVsZ/0gYnE6uTXi5aoDg8ed3AkJAz4sEje3Y8a29hQ1s6A99MZXe47fLAXQ1rTqaw==",
+            "dev": true,
+            "engines": {
+                "node": ">= 12.0.0"
+            }
+        },
        "node_modules/commist": {
            "version": "1.1.0",
            "resolved": "https://registry.npmjs.org/commist/-/commist-1.1.0.tgz",
@@ -8967,6 +9012,41 @@
                "url": "https://opencollective.com/eslint"
            }
        },
+        "node_modules/eslint-plugin-jsdoc": {
+            "version": "46.4.6",
+            "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-46.4.6.tgz",
+            "integrity": "sha512-z4SWYnJfOqftZI+b3RM9AtWL1vF/sLWE/LlO9yOKDof9yN2+n3zOdOJTGX/pRE/xnPsooOLG2Rq6e4d+XW3lNw==",
+            "dev": true,
+            "dependencies": {
+                "@es-joy/jsdoccomment": "~0.40.1",
+                "are-docs-informative": "^0.0.2",
+                "comment-parser": "1.4.0",
+                "debug": "^4.3.4",
+                "escape-string-regexp": "^4.0.0",
+                "esquery": "^1.5.0",
+                "is-builtin-module": "^3.2.1",
+                "semver": "^7.5.4",
+                "spdx-expression-parse": "^3.0.1"
+            },
+            "engines": {
+                "node": ">=16"
+            },
+            "peerDependencies": {
+                "eslint": "^7.0.0 || ^8.0.0"
+            }
+        },
+        "node_modules/eslint-plugin-jsdoc/node_modules/escape-string-regexp": {
+            "version": "4.0.0",
+            "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz",
+            "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==",
+            "dev": true,
+            "engines": {
+                "node": ">=10"
+            },
+            "funding": {
+                "url": "https://github.com/sponsors/sindresorhus"
+            }
+        },
        "node_modules/eslint-plugin-vue": {
            "version": "8.7.1",
            "resolved": "https://registry.npmjs.org/eslint-plugin-vue/-/eslint-plugin-vue-8.7.1.tgz",
@@ -10845,6 +10925,21 @@
                "url": "https://github.com/sponsors/ljharb"
            }
        },
+        "node_modules/is-builtin-module": {
+            "version": "3.2.1",
+            "resolved": "https://registry.npmjs.org/is-builtin-module/-/is-builtin-module-3.2.1.tgz",
+            "integrity": "sha512-BSLE3HnV2syZ0FK0iMA/yUGplUeMmNz4AW5fnTunbCIqZi4vG3WjJT9FHMy5D69xmAYBHXQhJdALdpwVxV501A==",
+            "dev": true,
+            "dependencies": {
+                "builtin-modules": "^3.3.0"
+            },
+            "engines": {
+                "node": ">=6"
+            },
+            "funding": {
+                "url": "https://github.com/sponsors/sindresorhus"
+            }
+        },
        "node_modules/is-callable": {
            "version": "1.2.7",
            "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz",
@@ -13025,6 +13120,15 @@
            "integrity": "sha512-UVU9dibq2JcFWxQPA6KCqj5O42VOmAY3zQUfEKxU0KpTGXwNoCjkX1e13eHNvw/xPynt6pU0rZ1htjWTNTSXsg==",
            "dev": true
        },
+        "node_modules/jsdoc-type-pratt-parser": {
+            "version": "4.0.0",
+            "resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-4.0.0.tgz",
+            "integrity": "sha512-YtOli5Cmzy3q4dP26GraSOeAhqecewG04hoO8DY56CH4KJ9Fvv5qKWUCCo3HZob7esJQHCv6/+bnTy72xZZaVQ==",
+            "dev": true,
+            "engines": {
+                "node": ">=12.0.0"
+            }
+        },
        "node_modules/jsesc": {
            "version": "3.0.2",
            "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-3.0.2.tgz",