From 8cb12dd09159b63d457aab0f956b89ce5ae3f672 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 3 May 2023 22:35:49 +0100 Subject: [PATCH] Update dependency eslint-plugin-jsdoc to v43 (#1061) Co-authored-by: April Sylph <28949509+AprilSylph@users.noreply.github.com> --- package-lock.json | 83 +++++++++++++++++++++++++++---------- package.json | 2 +- src/content_scripts/main.js | 1 - src/scripts/quick_reblog.js | 1 - src/util/control_buttons.js | 2 - src/util/crypto.js | 1 - src/util/dom.js | 1 - src/util/interface.js | 1 - src/util/meatballs.js | 2 - src/util/modals.js | 1 - src/util/mutations.js | 3 -- src/util/post_actions.js | 1 - src/util/react_props.js | 1 - src/util/tumblr_helpers.js | 1 - 14 files changed, 63 insertions(+), 38 deletions(-) diff --git a/package-lock.json b/package-lock.json index 0c9ff36e2..26c269fec 100644 --- a/package-lock.json +++ b/package-lock.json @@ -19,7 +19,7 @@ "eslint-config-semistandard": "^17.0.0", "eslint-config-standard": "^17.0.0", "eslint-plugin-import": "^2.27.5", - "eslint-plugin-jsdoc": "^40.3.0", + "eslint-plugin-jsdoc": "^43.1.1", "eslint-plugin-n": "^15.7.0", "eslint-plugin-promise": "^6.1.1", "web-ext": "^7.6.2" @@ -197,17 +197,17 @@ "dev": true }, "node_modules/@es-joy/jsdoccomment": { - "version": "0.37.0", - "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.37.0.tgz", - "integrity": "sha512-hjK0wnsPCYLlF+HHB4R/RbUjOWeLW2SlarB67+Do5WsKILOkmIZvvPJFbtWSmbypxcjpoECLAMzoao0D4Bg5ZQ==", + "version": "0.37.1", + "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.37.1.tgz", + "integrity": "sha512-5vxWJ1gEkEF0yRd0O+uK6dHJf7adrxwQSX8PuRiPfFSAbNLnY0ZJfXaZucoz14Jj2N11xn2DnlEPwWRpYpvRjg==", "dev": true, "dependencies": { "comment-parser": "1.3.1", - "esquery": "^1.4.0", + "esquery": "^1.5.0", "jsdoc-type-pratt-parser": "~4.0.0" }, "engines": { - "node": "^14 || ^16 || ^17 || ^18 || ^19" + "node": "^14 || ^16 || ^17 || ^18 || ^19 || ^20" } }, "node_modules/@eslint-community/eslint-utils": { @@ -971,6 +971,15 @@ "integrity": "sha512-7UvmKalWRt1wgjL1RrGxoSJW/0QZFIegpeGvZG9kjp8vrRu55XTHbwnqq2GpXm9uLbcuhxm3IqX9OB4MZR1b2A==", "dev": true }, + "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/argparse": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", @@ -2735,21 +2744,22 @@ } }, "node_modules/eslint-plugin-jsdoc": { - "version": "40.3.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-40.3.0.tgz", - "integrity": "sha512-EhCqpzRkxoT2DUB4AnrU0ggBYvTh3bWrLZzQTupq6vSVE6XzNwJVKsOHa41GCoevnsWMBNmoDVjXWGqckjuG1g==", + "version": "43.1.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-43.1.1.tgz", + "integrity": "sha512-J2kjjsJ5vBXSyNzqJhceeSGTAgVgZHcPSJKo3vD4tNjUdfky98rR2VfZUDsS1GKL6isyVa8GWvr+Az7Vyg2HXA==", "dev": true, "dependencies": { - "@es-joy/jsdoccomment": "~0.37.0", + "@es-joy/jsdoccomment": "~0.37.1", + "are-docs-informative": "^0.0.2", "comment-parser": "1.3.1", "debug": "^4.3.4", "escape-string-regexp": "^4.0.0", "esquery": "^1.5.0", - "semver": "^7.3.8", + "semver": "^7.5.0", "spdx-expression-parse": "^3.0.1" }, "engines": { - "node": "^14 || ^16 || ^17 || ^18 || ^19" + "node": ">=16" }, "peerDependencies": { "eslint": "^7.0.0 || ^8.0.0" @@ -2790,6 +2800,21 @@ "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", "dev": true }, + "node_modules/eslint-plugin-jsdoc/node_modules/semver": { + "version": "7.5.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.0.tgz", + "integrity": "sha512-+XC0AD/R7Q2mPSRuy2Id0+CGTZ98+8f+KvwirxOKIEyid+XSx6HbC63p+O4IndTHuX5Z+JxQ0TghCkO5Cg/2HA==", + "dev": true, + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, "node_modules/eslint-plugin-n": { "version": "15.7.0", "resolved": "https://registry.npmjs.org/eslint-plugin-n/-/eslint-plugin-n-15.7.0.tgz", @@ -7965,13 +7990,13 @@ "dev": true }, "@es-joy/jsdoccomment": { - "version": "0.37.0", - "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.37.0.tgz", - "integrity": "sha512-hjK0wnsPCYLlF+HHB4R/RbUjOWeLW2SlarB67+Do5WsKILOkmIZvvPJFbtWSmbypxcjpoECLAMzoao0D4Bg5ZQ==", + "version": "0.37.1", + "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.37.1.tgz", + "integrity": "sha512-5vxWJ1gEkEF0yRd0O+uK6dHJf7adrxwQSX8PuRiPfFSAbNLnY0ZJfXaZucoz14Jj2N11xn2DnlEPwWRpYpvRjg==", "dev": true, "requires": { "comment-parser": "1.3.1", - "esquery": "^1.4.0", + "esquery": "^1.5.0", "jsdoc-type-pratt-parser": "~4.0.0" } }, @@ -8554,6 +8579,12 @@ "integrity": "sha512-7UvmKalWRt1wgjL1RrGxoSJW/0QZFIegpeGvZG9kjp8vrRu55XTHbwnqq2GpXm9uLbcuhxm3IqX9OB4MZR1b2A==", "dev": true }, + "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 + }, "argparse": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", @@ -9891,17 +9922,18 @@ } }, "eslint-plugin-jsdoc": { - "version": "40.3.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-40.3.0.tgz", - "integrity": "sha512-EhCqpzRkxoT2DUB4AnrU0ggBYvTh3bWrLZzQTupq6vSVE6XzNwJVKsOHa41GCoevnsWMBNmoDVjXWGqckjuG1g==", + "version": "43.1.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-43.1.1.tgz", + "integrity": "sha512-J2kjjsJ5vBXSyNzqJhceeSGTAgVgZHcPSJKo3vD4tNjUdfky98rR2VfZUDsS1GKL6isyVa8GWvr+Az7Vyg2HXA==", "dev": true, "requires": { - "@es-joy/jsdoccomment": "~0.37.0", + "@es-joy/jsdoccomment": "~0.37.1", + "are-docs-informative": "^0.0.2", "comment-parser": "1.3.1", "debug": "^4.3.4", "escape-string-regexp": "^4.0.0", "esquery": "^1.5.0", - "semver": "^7.3.8", + "semver": "^7.5.0", "spdx-expression-parse": "^3.0.1" }, "dependencies": { @@ -9925,6 +9957,15 @@ "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", "dev": true + }, + "semver": { + "version": "7.5.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.0.tgz", + "integrity": "sha512-+XC0AD/R7Q2mPSRuy2Id0+CGTZ98+8f+KvwirxOKIEyid+XSx6HbC63p+O4IndTHuX5Z+JxQ0TghCkO5Cg/2HA==", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + } } } }, diff --git a/package.json b/package.json index 7f66658bc..e52831b92 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,7 @@ "eslint-config-semistandard": "^17.0.0", "eslint-config-standard": "^17.0.0", "eslint-plugin-import": "^2.27.5", - "eslint-plugin-jsdoc": "^40.3.0", + "eslint-plugin-jsdoc": "^43.1.1", "eslint-plugin-n": "^15.7.0", "eslint-plugin-promise": "^6.1.1", "web-ext": "^7.6.2" diff --git a/src/content_scripts/main.js b/src/content_scripts/main.js index b15658604..ffe52cded 100644 --- a/src/content_scripts/main.js +++ b/src/content_scripts/main.js @@ -87,7 +87,6 @@ /** * fixes WebKit (Chromium, Safari) simultaneous import failure of files with unresolved top level await - * * @see https://github.com/sveltejs/kit/issues/7805#issuecomment-1330078207 */ await Promise.all(['css_map', 'language_data', 'user'].map(name => import(getURL(`/util/${name}.js`)))); diff --git a/src/scripts/quick_reblog.js b/src/scripts/quick_reblog.js index 4cafc5db7..e13e69a5c 100644 --- a/src/scripts/quick_reblog.js +++ b/src/scripts/quick_reblog.js @@ -296,7 +296,6 @@ const updateRememberedBlog = async ({ currentTarget: { value: selectedBlog } }) /** * Chromium passes a full PointerEvent here; Firefox passes a MouseEvent. - * * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/contextmenu_event * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/mozInputSource */ diff --git a/src/util/control_buttons.js b/src/util/control_buttons.js index d776d2967..e4d8eea41 100644 --- a/src/util/control_buttons.js +++ b/src/util/control_buttons.js @@ -6,7 +6,6 @@ $('.xkit-control-button-container').remove(); /** * Create a button template that can be cloned with cloneControlButton() for inserting into the controls of a post. - * * @param {string} symbolId - The name of the RemixIcon to use * @param {string} buttonClass - An extra class to identify the extension that added the button * @returns {HTMLDivElement} A button that can be cloned with cloneControlButton() @@ -23,7 +22,6 @@ export const createControlButtonTemplate = function (symbolId, buttonClass) { /** * Create a deep-level clone of a button template that is ready to add to the page - * * @param {HTMLDivElement} template - A button template as returned by createControlButtonTemplate() * @param {object} events - An object of DOM Event names and handler functions, * e.g. { click: () => { alert('Hello!'); } } diff --git a/src/util/crypto.js b/src/util/crypto.js index d17360c8f..bfbbab33f 100644 --- a/src/util/crypto.js +++ b/src/util/crypto.js @@ -9,7 +9,6 @@ export const getRandomHexString = () => { /** * Get a hexadecimal SHA-256 hash of a given string - * * @see https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest#converting_a_digest_to_a_hex_string * @param {string} data - A USVString containing the data to hash * @returns {Promise} Hexadecimal string representing the data's SHA-256 digest diff --git a/src/util/dom.js b/src/util/dom.js index d3ba3bbe4..edbb5e0ec 100644 --- a/src/util/dom.js +++ b/src/util/dom.js @@ -1,6 +1,5 @@ /** * Create elements with simple syntax - * * @param {string} tagName - Type of element to create * @param {object} [attributes] - Property-value pairs to set as HTML/XML attributes (e.g. { href: '/' }) * @param {object} [events] - Property-value pairs to set as event listeners (e.g. { click: () => {} }) diff --git a/src/util/interface.js b/src/util/interface.js index c25b91dc6..811408224 100644 --- a/src/util/interface.js +++ b/src/util/interface.js @@ -55,7 +55,6 @@ export const buildStyle = (css = '') => dom('style', { class: 'xkit' }, null, [c /** * Determine a post's legacy type - * * @param {object} post - Destructured into content and layout * @param {Array} [post.trail] - Full post trail * @param {Array} [post.content] - Post content array diff --git a/src/util/meatballs.js b/src/util/meatballs.js index 0109bcf13..eadf49fa5 100644 --- a/src/util/meatballs.js +++ b/src/util/meatballs.js @@ -27,7 +27,6 @@ const blogMeatballItems = {}; /** * Add a custom button to posts' meatball menus. - * * @param {object} options - Destructured * @param {string} options.id - Identifier for this button (must be unique) * @param {string|Function} options.label - Button text to display. May be a function accepting the timelineObject data of the post element being actioned on. @@ -46,7 +45,6 @@ export const unregisterMeatballItem = id => { /** * Add a custom button to blogs' meatball menus in blog cards and the blog view header. - * * @param {object} options - Destructured * @param {string} options.id - Identifier for this button (must be unique) * @param {string|Function} options.label - Button text to display. May be a function accepting the blog data of the post element being actioned on. diff --git a/src/util/modals.js b/src/util/modals.js index 935481c71..83c81b26e 100644 --- a/src/util/modals.js +++ b/src/util/modals.js @@ -7,7 +7,6 @@ let lastFocusedElement; /** * Show a takeover prompt to the user - * * @param {object} options - Destructured * @param {string} [options.title] - Prompt title * @param {(string|Node)[]} [options.message] - Nodes to be displayed in the modal, to be used as prompts or non-submit inputs diff --git a/src/util/mutations.js b/src/util/mutations.js index bb6901cde..231e41260 100644 --- a/src/util/mutations.js +++ b/src/util/mutations.js @@ -9,7 +9,6 @@ export const pageModifications = Object.freeze({ /** * Register a page modification - * * @param {string} selector - CSS selector for elements to target * @param {Function} modifierFunction - Function to handle matching elements (accepts one Element[] argument) */ @@ -22,7 +21,6 @@ export const pageModifications = Object.freeze({ /** * Unregister a page modification - * * @param {Function} modifierFunction - Previously-registered function to remove */ unregister (modifierFunction) { @@ -31,7 +29,6 @@ export const pageModifications = Object.freeze({ /** * Run a page modification on all existing matching elements - * * @param {Function} modifierFunction - Previously-registered function to run */ trigger (modifierFunction) { diff --git a/src/util/post_actions.js b/src/util/post_actions.js index b3ae678f9..66272fe0b 100644 --- a/src/util/post_actions.js +++ b/src/util/post_actions.js @@ -25,7 +25,6 @@ pageModifications.register(keyToCss('postFormButton'), addPostOptions); /** * Create and register a button to add to the new post form - * * @param {string} id - Unique identifier for this post option * @param {object} options - Construction options for this post option * @param {string} options.symbolId - RemixIcon symbol to use diff --git a/src/util/react_props.js b/src/util/react_props.js index ade0ceb2e..f2fa18b95 100644 --- a/src/util/react_props.js +++ b/src/util/react_props.js @@ -94,7 +94,6 @@ const controlTagsInput = async ({ add, remove }) => { /** * Manipulate post form tags - * * @param {object} options - Tags to add/remove to/from the current post form * @param {string[]} [options.add] - Tags to insert * @param {string[]} [options.remove] - Tags to remove diff --git a/src/util/tumblr_helpers.js b/src/util/tumblr_helpers.js index 469bde5a3..a4cd303cc 100644 --- a/src/util/tumblr_helpers.js +++ b/src/util/tumblr_helpers.js @@ -48,7 +48,6 @@ export const apiFetch = async function (...args) { /** * Create an NPF edit request body. - * * @see https://github.com/tumblr/docs/blob/master/api.md#postspost-id---editing-a-post-neue-post-format * @see https://github.com/tumblr/docs/blob/master/api.md#posts---createreblog-a-post-neue-post-format * @param {object} postData - camelCased /posts/{post-id} GET request response JSON