Upgrade eslint-plugin-jsdoc to latest version (#24586)

* Upgrade eslint-plugin-jsdoc to latest version * Add CHANGELOG entry * Configure is-shallow-equal JSDoc mode as TypeScript Since the ESLint configuration is set as root, it must reconfigure its own JSDoc settings to inform parser that it should treat JSDoc as supporting TypeScript syntax
WordPress · Aug 16, 2020 · 375eaa0 · 375eaa0
1 parent 068064a
commit 375eaa0
Show file tree

Hide file tree

Showing 10 changed files with 24 additions and 34 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/block-editor/src/components/link-control/index.js b/packages/block-editor/src/components/link-control/index.js
@@ -50,14 +50,12 @@ import { ViewerFill } from './viewer-slot';
  * @property {string} title Human-readable label to show in user interface.
  */
 
-/* eslint-disable jsdoc/valid-types */
 /**
  * Properties associated with a link control value, composed as a union of the
  * default properties and any custom settings values.
  *
  * @typedef {WPLinkControlDefaultValue&WPLinkControlSettingsValue} WPLinkControlValue
  */
-/* eslint-enable */
 
 /** @typedef {(nextValue:WPLinkControlValue)=>void} WPLinkControlOnChangeProp */
 

diff --git a/packages/element/src/raw-html.js b/packages/element/src/raw-html.js
@@ -4,9 +4,7 @@
 import { createElement } from './react';
 
 // Disable reason: JSDoc linter doesn't seem to parse the union (`&`) correctly.
-/* eslint-disable jsdoc/valid-types */
 /** @typedef {{children: string} & import('react').ComponentPropsWithoutRef<'div'>} RawHTMLProps */
-/* eslint-enable jsdoc/valid-types */
 
 /**
  * Component used as equivalent of Fragment with unescaped HTML, in cases where

diff --git a/packages/eslint-plugin/CHANGELOG.md b/packages/eslint-plugin/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Enhancements
+
+-   The bundled `eslint-plugin-jsdoc` dependency has been updated from requiring `^26.0.0` to requiring `^30.2.2`.
+
 ## 7.1.0-rc.0 (2020-06-24)
 
 ### Enhancements

diff --git a/packages/eslint-plugin/package.json b/packages/eslint-plugin/package.json
@@ -31,7 +31,7 @@
 		"babel-eslint": "^10.1.0",
 		"eslint-config-prettier": "^6.10.1",
 		"eslint-plugin-jest": "^23.8.2",
-		"eslint-plugin-jsdoc": "^26.0.0",
+		"eslint-plugin-jsdoc": "^30.2.2",
 		"eslint-plugin-jsx-a11y": "^6.2.3",
 		"eslint-plugin-prettier": "^3.1.2",
 		"eslint-plugin-react": "^7.20.0",

diff --git a/packages/icons/src/icon/index.js b/packages/icons/src/icon/index.js
@@ -4,9 +4,7 @@
 import { cloneElement } from '@wordpress/element';
 
 // Disable reason: JSDoc linter doesn't seem to parse the union (`&`) correctly.
-/* eslint-disable jsdoc/valid-types */
 /** @typedef {{icon: JSX.Element, size?: number} & import('react').ComponentPropsWithoutRef<'SVG'>} IconProps */
-/* eslint-enable jsdoc/valid-types */
 
 /**
  * Return an SVG icon.

diff --git a/packages/is-shallow-equal/.eslintrc.json b/packages/is-shallow-equal/.eslintrc.json
@@ -6,6 +6,11 @@
 	"env": {
 		"node": true
 	},
+	"settings": {
+		"jsdoc": {
+			"mode": "typescript"
+		}
+	},
 	"overrides": [
 		{
 			"files": [ "@(test|benchmark)/*.js" ],

diff --git a/packages/prettier-config/lib/index.js b/packages/prettier-config/lib/index.js
@@ -9,9 +9,7 @@
 // Disable reason: The current JSDoc tooling does not yet understand TypeScript
 // union types.
 
-/* eslint-disable jsdoc/valid-types */
 /** @type {PrettierOptions & WPPrettierOptions} */
-/* eslint-enable jsdoc/valid-types */
 const config = {
 	useTabs: true,
 	tabWidth: 4,

diff --git a/packages/primitives/src/svg/index.js b/packages/primitives/src/svg/index.js
@@ -8,10 +8,7 @@ import classnames from 'classnames';
  */
 import { createElement } from '@wordpress/element';
 
-// Disable reason: JSDoc linter doesn't seem to parse the union (`&`) correctly.
-/* eslint-disable jsdoc/valid-types */
 /** @typedef {{isPressed?: boolean} & import('react').ComponentPropsWithoutRef<'svg'>} SVGProps */
-/* eslint-enable jsdoc/valid-types */
 
 /**
  * @param {import('react').ComponentPropsWithoutRef<'circle'>} props

diff --git a/packages/priority-queue/src/index.js b/packages/priority-queue/src/index.js
@@ -74,14 +74,12 @@ export const createQueue = () => {
 
 	let isRunning = false;
 
-	/* eslint-disable jsdoc/valid-types */
 	/**
 	 * Callback to process as much queue as time permits.
 	 *
 	 * @param {IdleDeadline|number} deadline Idle callback deadline object, or
 	 *                                       animation frame timestamp.
 	 */
-	/* eslint-enable */
 	const runWaitingList = ( deadline ) => {
 		const hasTimeRemaining =
 			typeof deadline === 'number'