Skip to content

Commit

Permalink
Update dependency eslint-plugin-jsdoc to v43 (#1061)
Browse files Browse the repository at this point in the history
Co-authored-by: April Sylph <28949509+AprilSylph@users.noreply.github.com>
  • Loading branch information
renovate[bot] and AprilSylph authored May 3, 2023
1 parent eeb8e9e commit 8cb12dd
Show file tree
Hide file tree
Showing 14 changed files with 63 additions and 38 deletions.
83 changes: 62 additions & 21 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
1 change: 0 additions & 1 deletion src/content_scripts/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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`))));
Expand Down
1 change: 0 additions & 1 deletion src/scripts/quick_reblog.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 0 additions & 2 deletions src/util/control_buttons.js
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand All @@ -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!'); } }
Expand Down
1 change: 0 additions & 1 deletion src/util/crypto.js
Original file line number Diff line number Diff line change
Expand Up @@ -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<string>} Hexadecimal string representing the data's SHA-256 digest
Expand Down
1 change: 0 additions & 1 deletion src/util/dom.js
Original file line number Diff line number Diff line change
@@ -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: () => {} })
Expand Down
1 change: 0 additions & 1 deletion src/util/interface.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions src/util/meatballs.js
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down
1 change: 0 additions & 1 deletion src/util/modals.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions src/util/mutations.js
Original file line number Diff line number Diff line change
Expand Up @@ -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)
*/
Expand All @@ -22,7 +21,6 @@ export const pageModifications = Object.freeze({

/**
* Unregister a page modification
*
* @param {Function} modifierFunction - Previously-registered function to remove
*/
unregister (modifierFunction) {
Expand All @@ -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) {
Expand Down
1 change: 0 additions & 1 deletion src/util/post_actions.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion src/util/react_props.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion src/util/tumblr_helpers.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 8cb12dd

Please sign in to comment.