@wordpress/eslint-plugin 25.2.1-next.v.202605131032.0 → 25.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/eslint-plugin",
-	"version": "25.2.1-next.v.202605131032.0+f6d6e7149",
+	"version": "25.3.0",
 	"description": "ESLint plugin for WordPress development.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -44,9 +44,9 @@
 		"@babel/eslint-parser": "^7.28.6",
 		"@eslint-community/eslint-plugin-eslint-comments": "^4.4.0",
 		"@eslint/compat": "^2.0.0",
-		"@wordpress/babel-preset-default": "^8.45.1-next.v.202605131032.0+f6d6e7149",
-		"@wordpress/prettier-config": "^4.45.1-next.v.202605131032.0+f6d6e7149",
-		"@wordpress/theme": "^0.13.1-next.v.202605131032.0+f6d6e7149",
+		"@wordpress/babel-preset-default": "^8.47.0",
+		"@wordpress/prettier-config": "^4.47.0",
+		"@wordpress/theme": "^0.14.0",
 		"cosmiconfig": "^7.0.0",
 		"eslint-config-prettier": "^10.0.0",
 		"eslint-import-resolver-typescript": "^4.4.4",
@@ -83,5 +83,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "0e198c7ac7ca634e73ded9220ce048c0302174dd"
+	"gitHead": "d653c5fd6161571a0c2ebde28553d6e25624eacc"
 }

package/rules/__tests__/use-import-as.js

@@ -66,10 +66,6 @@ ruleTester.run( 'use-import-as', rule, {
 			code: "import { VisuallyHidden as WCVisuallyHidden } from '@wordpress/components';",
 			options,
 		},
-		{
-			code: 'import { "VisuallyHidden" as WCVisuallyHidden } from \'@wordpress/components\';',
-			options,
-		},
 		{
 			code: "import { Button, VisuallyHidden as WCVisuallyHidden } from '@wordpress/components';",
 			options,
@@ -95,9 +91,9 @@ ruleTester.run( 'use-import-as', rule, {
 		{
 			code: `
 				import { privateApis } from '@wordpress/components';
-				import { unlock as open } from '../../lock-unlock';
+				import { unlock } from '../../lock-unlock';
 
-				const { Badge: WCBadge = fallbackBadge } = open( privateApis );
+				const { Badge: WCBadge = fallbackBadge } = unlock( privateApis );
 			`,
 			options,
 		},
@@ -161,17 +157,6 @@ ruleTester.run( 'use-import-as', rule, {
 				),
 			],
 		},
-		{
-			code: 'import { "VisuallyHidden" as Hidden } from \'@wordpress/components\';',
-			options,
-			errors: [
-				withSuggestions(
-					'`VisuallyHidden` from `@wordpress/components` must be imported as `WCVisuallyHidden`.',
-					'import { "VisuallyHidden" as WCVisuallyHidden } from \'@wordpress/components\';',
-					'Import as `WCVisuallyHidden`.'
-				),
-			],
-		},
 		{
 			code: "import { Button, VisuallyHidden } from '@wordpress/components';",
 			options,

package/rules/__tests__/use-recommended-components.js

@@ -1,11 +1,4 @@
-/**
- * External dependencies
- */
 import { RuleTester } from 'eslint';
-
-/**
- * Internal dependencies
- */
 import rule, { ALLOWLIST, DENYLIST } from '../use-recommended-components';
 
 const ruleTester = new RuleTester( {
@@ -27,10 +20,28 @@ ruleTester.run( 'use-recommended-components', rule, {
 
 		// Allowed @wordpress/ui components.
 		"import { Badge } from '@wordpress/ui';",
+		"import { Icon } from '@wordpress/ui';",
 		"import { Link } from '@wordpress/ui';",
 		"import { Stack } from '@wordpress/ui';",
 		"import { Text } from '@wordpress/ui';",
-		"import { Badge, Link, Stack, Text } from '@wordpress/ui';",
+		"import { Badge, Icon, Link, Stack, Tabs, Text } from '@wordpress/ui';",
+
+		// Unlocked private APIs are only checked for denied names.
+		"import { privateApis } from '@wordpress/components'; import { unlock } from '../../lock-unlock'; const { SomethingElse } = unlock( privateApis );",
+		`
+			import { privateApis } from '@wordpress/components';
+			import { unlock } from '../../lock-unlock';
+
+			function test() {
+				function unlock( value ) {
+					return value;
+				}
+
+				const { Tabs } = unlock( privateApis );
+
+				return Tabs;
+			}
+		`,
 	],
 
 	invalid: [
@@ -76,6 +87,33 @@ ruleTester.run( 'use-recommended-components', rule, {
 				},
 			],
 		},
+		{
+			code: "import { Tabs, TabPanel } from '@wordpress/components';",
+			errors: [
+				{
+					message: 'Use `Tabs` from `@wordpress/ui` instead.',
+				},
+				{
+					message: 'Use `Tabs` from `@wordpress/ui` instead.',
+				},
+			],
+		},
+		{
+			code: "import { privateApis } from '@wordpress/components'; import { unlock } from '../../lock-unlock'; const { Tabs } = unlock( privateApis );",
+			errors: [
+				{
+					message: 'Use `Tabs` from `@wordpress/ui` instead.',
+				},
+			],
+		},
+		{
+			code: "import { privateApis as componentsPrivateApis } from '@wordpress/components'; import { unlock } from '../../lock-unlock'; const { Tabs: WCTabs } = unlock( componentsPrivateApis );",
+			errors: [
+				{
+					message: 'Use `Tabs` from `@wordpress/ui` instead.',
+				},
+			],
+		},
 	],
 } );
 

package/rules/use-import-as.js

@@ -1,3 +1,10 @@
+const {
+	createPrivateApisState,
+	trackPrivateApisSpecifier,
+	getPropertyName,
+	getUnlockDestructuring,
+} = require( '../utils/private-apis' );
+
 /** @type {import('eslint').Rule.RuleModule} */
 const rule = {
 	meta: {
@@ -34,8 +41,7 @@ const rule = {
 			typeof context.options[ 0 ] === 'object'
 				? context.options[ 0 ]
 				: {};
-		const privateApisSources = new Map();
-		const trackedUnlockImports = new Set();
+		const privateApisState = createPrivateApisState();
 
 		return {
 			/** @param {import('estree').ImportDeclaration} node */
@@ -52,21 +58,24 @@ const rule = {
 						return;
 					}
 
-					const importedName = getImportedName( specifier );
-					if ( importedName === 'unlock' ) {
-						trackedUnlockImports.add( specifier.local.name );
-					}
+					const importedName = specifier.imported.name;
+					trackPrivateApisSpecifier(
+						privateApisState,
+						specifier,
+						source,
+						!! sourceMap
+					);
 
 					if ( ! sourceMap ) {
 						return;
 					}
 
-					if ( importedName === 'privateApis' ) {
-						privateApisSources.set( specifier.local.name, source );
+					if ( ! sourceMap.hasOwnProperty( importedName ) ) {
+						return;
 					}
-					const localName = sourceMap[ importedName ];
 
-					if ( ! localName || specifier.local.name === localName ) {
+					const localName = sourceMap[ importedName ];
+					if ( specifier.local.name === localName ) {
 						return;
 					}
 
@@ -101,50 +110,31 @@ const rule = {
 			},
 			/** @param {import('estree').VariableDeclarator} node */
 			VariableDeclarator( node ) {
-				if (
-					node.parent.type !== 'VariableDeclaration' ||
-					node.parent.kind !== 'const' ||
-					node.id.type !== 'ObjectPattern' ||
-					! isUnlockCall(
-						node.init,
-						context.sourceCode,
-						trackedUnlockImports
-					)
-				) {
-					return;
-				}
-
-				const privateApisIdentifier = node.init.arguments[ 0 ];
-				if ( privateApisIdentifier.type !== 'Identifier' ) {
-					return;
-				}
-
-				const source = privateApisSources.get(
-					privateApisIdentifier.name
+				const unlockDestructuring = getUnlockDestructuring(
+					node,
+					context.sourceCode,
+					privateApisState
 				);
-				if ( ! source ) {
+				if ( ! unlockDestructuring ) {
 					return;
 				}
 
+				const { source, properties } = unlockDestructuring;
 				const sourceMap = importAsMap[ source ];
 				if ( ! sourceMap ) {
 					return;
 				}
 
-				node.id.properties.forEach( ( property ) => {
-					if ( property.type !== 'Property' || property.computed ) {
-						return;
-					}
-
+				properties.forEach( ( property ) => {
 					const importedName = getPropertyName( property.key );
-					if ( ! importedName ) {
+					if (
+						! importedName ||
+						! sourceMap.hasOwnProperty( importedName )
+					) {
 						return;
 					}
 
 					const localName = sourceMap[ importedName ];
-					if ( ! localName ) {
-						return;
-					}
 
 					const propertyLocalName = getPropertyLocalName(
 						property.value
@@ -189,16 +179,6 @@ const rule = {
 	},
 };
 
-/**
- * @param {import('estree').ImportSpecifier} specifier
- * @return {string} Imported name.
- */
-function getImportedName( specifier ) {
-	return specifier.imported.type === 'Identifier'
-		? specifier.imported.name
-		: String( specifier.imported.value );
-}
-
 /**
  * @param {import('estree').ImportSpecifier} specifier
  * @param {import('eslint').SourceCode}      sourceCode
@@ -209,52 +189,6 @@ function getImportSpecifierSuggestionText( specifier, sourceCode, localName ) {
 	return `${ sourceCode.getText( specifier.imported ) } as ${ localName }`;
 }
 
-/**
- * @param {import('estree').CallExpression|import('estree').Expression|null} node
- * @param {import('eslint').SourceCode}                                      sourceCode
- * @param {ReadonlySet<string>}                                              trackedUnlockImports
- * @return {node is import('estree').CallExpression} Whether this is an `unlock()` call with one argument.
- */
-function isUnlockCall( node, sourceCode, trackedUnlockImports ) {
-	if (
-		node &&
-		node.type === 'CallExpression' &&
-		node.callee.type === 'Identifier' &&
-		node.arguments.length === 1
-	) {
-		if ( ! trackedUnlockImports.has( node.callee.name ) ) {
-			return false;
-		}
-
-		const { references } = sourceCode.getScope( node.callee );
-		const reference = references.find(
-			( currentReference ) => currentReference.identifier === node.callee
-		);
-
-		return !! reference?.resolved?.defs.some(
-			( definition ) => definition.type === 'ImportBinding'
-		);
-	}
-
-	return false;
-}
-
-/**
- * @param {import('estree').Expression|import('estree').PrivateIdentifier} key
- * @return {string|null} Property name.
- */
-function getPropertyName( key ) {
-	if ( key.type === 'Identifier' ) {
-		return key.name;
-	}
-
-	if ( key.type === 'Literal' ) {
-		return String( key.value );
-	}
-
-	return null;
-}
-
 /**
  * @param {import('estree').Property}   property
  * @param {import('eslint').SourceCode} sourceCode

package/rules/use-recommended-components.js

@@ -1,3 +1,10 @@
+const {
+	createPrivateApisState,
+	trackPrivateApisSpecifier,
+	getPropertyName,
+	getUnlockDestructuring,
+} = require( '../utils/private-apis' );
+
 /**
  * Allowlist: only the listed components are permitted from these packages.
  * Any other named import will be flagged with the package's message.
@@ -14,8 +21,10 @@ const ALLOWLIST = {
 			'Collapsible',
 			'CollapsibleCard',
 			'EmptyState',
+			'Icon',
 			'Link',
 			'Stack',
+			'Tabs',
 			'Text',
 			'VisuallyHidden',
 		],
@@ -49,6 +58,8 @@ const DENYLIST = {
 		CardHeader:
 			'Use `Card.Header` (and optionally `Card.Title`) from `@wordpress/ui` instead.',
 		CardMedia: 'Use `Card.FullBleed` from `@wordpress/ui` instead.',
+		TabPanel: 'Use `Tabs` from `@wordpress/ui` instead.',
+		Tabs: 'Use `Tabs` from `@wordpress/ui` instead.',
 		VisuallyHidden: 'Use `{{ name }}` from `@wordpress/ui` instead.',
 	},
 };
@@ -65,6 +76,8 @@ const rule = {
 		schema: [],
 	},
 	create( context ) {
+		const privateApisState = createPrivateApisState();
+
 		return {
 			/** @param {import('estree').ImportDeclaration} node */
 			ImportDeclaration( node ) {
@@ -77,16 +90,22 @@ const rule = {
 				const allowlistEntry = ALLOWLIST[ source ];
 				const denylistEntry = DENYLIST[ source ];
 
-				if ( ! allowlistEntry && ! denylistEntry ) {
-					return;
-				}
-
 				node.specifiers.forEach( ( specifier ) => {
 					if ( specifier.type !== 'ImportSpecifier' ) {
 						return;
 					}
 
 					const name = specifier.imported.name;
+					trackPrivateApisSpecifier(
+						privateApisState,
+						specifier,
+						source,
+						!! denylistEntry
+					);
+
+					if ( ! allowlistEntry && ! denylistEntry ) {
+						return;
+					}
 
 					if (
 						allowlistEntry &&
@@ -114,6 +133,39 @@ const rule = {
 					}
 				} );
 			},
+			/** @param {import('estree').VariableDeclarator} node */
+			VariableDeclarator( node ) {
+				const unlockDestructuring = getUnlockDestructuring(
+					node,
+					context.sourceCode,
+					privateApisState
+				);
+				if ( ! unlockDestructuring ) {
+					return;
+				}
+
+				const { source, properties } = unlockDestructuring;
+				const denylistEntry = DENYLIST[ source ];
+				if ( ! denylistEntry ) {
+					return;
+				}
+
+				properties.forEach( ( property ) => {
+					const name = getPropertyName( property.key );
+					if ( ! name || ! denylistEntry.hasOwnProperty( name ) ) {
+						return;
+					}
+
+					context.report( {
+						node: property.key,
+						message: resolveMessage(
+							denylistEntry[ name ],
+							name,
+							source
+						),
+					} );
+				} );
+			},
 		};
 	},
 };

package/utils/private-apis.js

@@ -0,0 +1,118 @@
+/**
+ * Shared helpers for ESLint rules that inspect `unlock( privateApis )` usage.
+ */
+
+/**
+ * @typedef {{ privateApisSources: Map<string, string> }} PrivateApisState
+ */
+
+/**
+ * @return {PrivateApisState} Mutable state for tracking `unlock` and `privateApis` imports.
+ */
+function createPrivateApisState() {
+	return {
+		privateApisSources: new Map(),
+	};
+}
+
+/**
+ * Records imported `privateApis` → package source when requested.
+ *
+ * @param {PrivateApisState}                 state
+ * @param {import('estree').ImportSpecifier} specifier
+ * @param {string}                           source
+ * @param {boolean}                          trackPrivateApis
+ */
+function trackPrivateApisSpecifier(
+	state,
+	specifier,
+	source,
+	trackPrivateApis
+) {
+	const name = specifier.imported.name;
+	if ( trackPrivateApis && name === 'privateApis' ) {
+		state.privateApisSources.set( specifier.local.name, source );
+	}
+}
+
+/**
+ * @param {import('estree').CallExpression|import('estree').Expression|null} node
+ * @param {import('eslint').SourceCode}                                      sourceCode
+ * @return {node is import('estree').CallExpression} Whether this is an `unlock()` call with one argument.
+ */
+function isUnlockCall( node, sourceCode ) {
+	if (
+		node &&
+		node.type === 'CallExpression' &&
+		node.callee.type === 'Identifier' &&
+		node.callee.name === 'unlock' &&
+		node.arguments.length === 1
+	) {
+		const { references } = sourceCode.getScope( node.callee );
+		const reference = references.find(
+			( currentReference ) => currentReference.identifier === node.callee
+		);
+
+		return !! reference?.resolved?.defs.some(
+			( definition ) => definition.type === 'ImportBinding'
+		);
+	}
+
+	return false;
+}
+
+/**
+ * @param {import('estree').Expression|import('estree').PrivateIdentifier} key
+ * @return {string|null} Static name of an object pattern property key.
+ */
+function getPropertyName( key ) {
+	if ( key.type === 'Identifier' ) {
+		return key.name;
+	}
+
+	if ( key.type === 'Literal' ) {
+		return String( key.value );
+	}
+
+	return null;
+}
+
+/**
+ * Parses `const { … } = unlock( privateApis )` and returns the package source and properties.
+ *
+ * @param {import('estree').VariableDeclarator} node
+ * @param {import('eslint').SourceCode}         sourceCode
+ * @param {PrivateApisState}                    state
+ * @return {{ source: string, properties: import('estree').Property[] }|null} Unlock destructuring context.
+ */
+function getUnlockDestructuring( node, sourceCode, state ) {
+	if (
+		node.id.type !== 'ObjectPattern' ||
+		! isUnlockCall( node.init, sourceCode )
+	) {
+		return null;
+	}
+
+	const privateApisIdentifier = node.init.arguments[ 0 ];
+	if ( privateApisIdentifier.type !== 'Identifier' ) {
+		return null;
+	}
+
+	const source = state.privateApisSources.get( privateApisIdentifier.name );
+	if ( ! source ) {
+		return null;
+	}
+
+	const properties = node.id.properties.filter(
+		( property ) => property.type === 'Property' && ! property.computed
+	);
+
+	return { source, properties };
+}
+
+module.exports = {
+	createPrivateApisState,
+	trackPrivateApisSpecifier,
+	getPropertyName,
+	getUnlockDestructuring,
+};