Skip to content

Commit c083f70

Browse files
authored
ESLint Plugin: Bring JSDoc plugin to the latest version (#53629)
* ESLint Plugin: Bring JSDoc plugin to the latest version * Add CHANGELOG entry
1 parent b04b4ae commit c083f70

File tree

17 files changed

+128
-64
lines changed

17 files changed

+128
-64
lines changed

package-lock.json

+109-48
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/block-editor/src/components/block-preview/index.js

-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,6 @@ export default memo( BlockPreview );
106106
* @param {Object} options.props Optional. Props to pass to the element. Must contain
107107
* the ref if one is defined.
108108
* @param {Object} options.layout Layout settings to be used in the preview.
109-
*
110109
*/
111110
export function useBlockPreview( { blocks, props = {}, layout } ) {
112111
const originalSettings = useSelect(

packages/block-editor/src/components/global-styles/use-global-styles-output.js

-1
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,6 @@ function flattenTree( input = {}, prefix, token ) {
198198
*
199199
* @param {string} styleVariationSelector The style variation selector.
200200
* @return {string} Combined selector string.
201-
*
202201
*/
203202
function concatFeatureVariationSelectorString(
204203
featureSelector,

packages/block-editor/src/store/actions.js

-1
Original file line numberDiff line numberDiff line change
@@ -1819,7 +1819,6 @@ export function __unstableSetTemporarilyEditingAsBlocks(
18191819
* the report url for the media item. It accepts the `InserterMediaItem` as an argument.
18201820
* @property {boolean} [isExternalResource] If the media category is an external resource, this should be set to true.
18211821
* This is used to avoid making a request to the external resource when the user
1822-
*
18231822
*/
18241823
export const registerInserterMediaCategory =
18251824
( category ) =>

packages/block-library/src/index.native.js

-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,6 @@ export const coreBlocks = [
122122
* Function to register a block variations e.g. social icons different types.
123123
*
124124
* @param {Object} block The block which variations will be registered.
125-
*
126125
*/
127126
const registerBlockVariations = ( block ) => {
128127
const { metadata, settings, name } = block;

packages/block-library/src/navigation-link/update-attributes.js

-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ import { safeDecodeURI } from '@wordpress/url';
2727
* @param {Object} updatedValue New block attributes to update.
2828
* @param {Function} setAttributes Block attribute update function.
2929
* @param {WPNavigationLinkBlockAttributes} blockAttributes Current block attributes.
30-
*
3130
*/
3231

3332
export const updateAttributes = (

packages/compose/src/hooks/use-resize-observer/index.native.js

-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ import { useState, useCallback } from '@wordpress/element';
2424
* );
2525
* };
2626
* ```
27-
*
2827
*/
2928
const useResizeObserver = () => {
3029
const [ measurements, setMeasurements ] = useState( null );

packages/data/src/plugins/persistence/index.js

-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ import { combineReducers } from '../../';
2121
* at least implement `getItem` and `setItem` of
2222
* the Web Storage API.
2323
* @property {string} storageKey Key on which to set in persistent storage.
24-
*
2524
*/
2625

2726
/**

packages/e2e-test-utils/src/set-option.js

-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ import { pressKeyWithModifier } from './press-key-with-modifier';
1313
* @param {string} value The value to set the option to.
1414
*
1515
* @return {string} The previous value of the option.
16-
*
1716
*/
1817
export async function setOption( setting, value ) {
1918
await switchUserToAdmin();

packages/edit-widgets/src/index.js

-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,6 @@ export function reinitializeEditor() {
112112
* Function to register an individual block.
113113
*
114114
* @param {Object} block The block to be registered.
115-
*
116115
*/
117116
const registerBlock = ( block ) => {
118117
if ( ! block ) {

packages/eslint-plugin/CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
## Unreleased
44

5+
### Breaking Changes
6+
7+
- The bundled `eslint-plugin-jsdoc` dependency has been updated from requiring ^39.6.9 to requiring ^46.4.6 ([#53629](https://github.com/WordPress/gutenberg/pull/53629)):
8+
- Removes `jsdoc/newline-after-description` rule in favor of `jsdoc/tag-lines` with option `startLines: 0` for "never" and `startLines: 1` for "always". Defaults now to `startLines: null`.
9+
- Removes `dropEndLines: true` from `jsdoc/tag-lines` in favor of option `endLines: 0`.
10+
- Drops `jsdoc/tag-lines` rule's `noEndLines: true` in favor of `applyToEndTag: false`.
11+
- Disables the newly introduced `jsdoc/no-defaults` rule.
12+
513
### Enhancement
614

715
- Support Typescript 5 and 5.1 by updating both `@typescript-eslint/parser` and `@typescript-eslint/eslint-plugin` to version `^5.62.0`. ([#52621](https://github.com/WordPress/gutenberg/pull/52621)).

0 commit comments

Comments
 (0)