@wordpress/eslint-plugin 24.6.1-next.v.202604091042.0 → 25.0.0

package/configs/jsdoc.js

@@ -2,6 +2,7 @@
  * External dependencies
  */
 const globals = require( 'globals' );
+const jsdocPlugin = require( 'eslint-plugin-jsdoc' );
 
 /**
  * The temporary list of types defined in Gutenberg which are allowed to avoid
@@ -72,83 +73,85 @@ const typescriptUtilityTypes = [
 	'false',
 ];
 
-module.exports = {
-	extends: [ 'plugin:jsdoc/recommended' ],
-	settings: {
-		jsdoc: {
-			preferredTypes: {
-				object: 'Object',
-			},
-			tagNamePreference: {
-				returns: 'return',
-				yields: 'yield',
+module.exports = [
+	jsdocPlugin.configs[ 'flat/recommended' ],
+	{
+		settings: {
+			jsdoc: {
+				preferredTypes: {
+					object: 'Object',
+				},
+				tagNamePreference: {
+					returns: 'return',
+					yields: 'yield',
+				},
 			},
 		},
+		rules: {
+			'jsdoc/no-defaults': 'off',
+			'jsdoc/no-undefined-types': [
+				'error',
+				{
+					definedTypes: [
+						// Required to reference browser types because we don't have the `browser` environment enabled for the project.
+						// Here we filter out all browser globals that don't begin with an uppercase letter because those
+						// generally refer to window-level event listeners and are not a valid type to reference (e.g. `onclick`).
+						...Object.keys( globals.browser ).filter( ( k ) =>
+							/^[A-Z]/.test( k )
+						),
+						...typescriptUtilityTypes,
+						...temporaryWordPressInternalTypes,
+						...temporaryExternalTypes,
+						'void',
+						'React',
+					],
+				},
+			],
+			'jsdoc/require-jsdoc': 'off',
+			'jsdoc/require-param-description': 'off',
+			'jsdoc/require-returns': 'off',
+			'jsdoc/require-yields': 'off',
+			'jsdoc/tag-lines': [
+				1,
+				'any',
+				{
+					startLines: null,
+					endLines: 0,
+					applyToEndTag: false,
+				},
+			],
+			'jsdoc/no-multi-asterisks': [
+				'error',
+				{ preventAtMiddleLines: false },
+			],
+			'jsdoc/check-access': 'error',
+			'jsdoc/check-alignment': 'error',
+			'jsdoc/check-line-alignment': [
+				'error',
+				'always',
+				{
+					tags: [ 'param', 'arg', 'argument', 'property', 'prop' ],
+					preserveMainDescriptionPostDelimiter: true,
+				},
+			],
+			'jsdoc/check-param-names': 'error',
+			'jsdoc/check-property-names': 'error',
+			'jsdoc/check-tag-names': 'error',
+			'jsdoc/check-types': 'error',
+			'jsdoc/check-values': 'off',
+			'jsdoc/empty-tags': 'error',
+			'jsdoc/implements-on-classes': 'error',
+			'jsdoc/require-param': 'error',
+			'jsdoc/require-param-name': 'error',
+			'jsdoc/require-param-type': 'error',
+			'jsdoc/require-property': 'error',
+			'jsdoc/require-property-description': 'error',
+			'jsdoc/require-property-name': 'error',
+			'jsdoc/require-property-type': 'error',
+			'jsdoc/require-returns-check': 'error',
+			'jsdoc/require-returns-description': 'error',
+			'jsdoc/require-returns-type': 'error',
+			'jsdoc/valid-types': 'error',
+		},
 	},
-	rules: {
-		'jsdoc/no-defaults': 'off',
-		'jsdoc/no-undefined-types': [
-			'error',
-			{
-				definedTypes: [
-					// Required to reference browser types because we don't have the `browser` environment enabled for the project.
-					// Here we filter out all browser globals that don't begin with an uppercase letter because those
-					// generally refer to window-level event listeners and are not a valid type to reference (e.g. `onclick`).
-					...Object.keys( globals.browser ).filter( ( k ) =>
-						/^[A-Z]/.test( k )
-					),
-					...typescriptUtilityTypes,
-					...temporaryWordPressInternalTypes,
-					...temporaryExternalTypes,
-					'void',
-					'React',
-				],
-			},
-		],
-		'jsdoc/require-jsdoc': 'off',
-		'jsdoc/require-param-description': 'off',
-		'jsdoc/require-returns': 'off',
-		'jsdoc/require-yields': 'off',
-		'jsdoc/tag-lines': [
-			1,
-			'any',
-			{
-				startLines: null,
-				endLines: 0,
-				applyToEndTag: false,
-			},
-		],
-		'jsdoc/no-multi-asterisks': [
-			'error',
-			{ preventAtMiddleLines: false },
-		],
-		'jsdoc/check-access': 'error',
-		'jsdoc/check-alignment': 'error',
-		'jsdoc/check-line-alignment': [
-			'error',
-			'always',
-			{
-				tags: [ 'param', 'arg', 'argument', 'property', 'prop' ],
-				preserveMainDescriptionPostDelimiter: true,
-			},
-		],
-		'jsdoc/check-param-names': 'error',
-		'jsdoc/check-property-names': 'error',
-		'jsdoc/check-tag-names': 'error',
-		'jsdoc/check-types': 'error',
-		'jsdoc/check-values': 'off',
-		'jsdoc/empty-tags': 'error',
-		'jsdoc/implements-on-classes': 'error',
-		'jsdoc/require-param': 'error',
-		'jsdoc/require-param-name': 'error',
-		'jsdoc/require-param-type': 'error',
-		'jsdoc/require-property': 'error',
-		'jsdoc/require-property-description': 'error',
-		'jsdoc/require-property-name': 'error',
-		'jsdoc/require-property-type': 'error',
-		'jsdoc/require-returns-check': 'error',
-		'jsdoc/require-returns-description': 'error',
-		'jsdoc/require-returns-type': 'error',
-		'jsdoc/valid-types': 'error',
-	},
-};
+];

package/configs/jshint.js

@@ -1,17 +1,19 @@
-module.exports = {
-	rules: {
-		curly: 'error',
-		eqeqeq: 'error',
-		'no-caller': 'error',
-		'no-cond-assign': [ 'error', 'except-parens' ],
-		'no-eq-null': 'error',
-		'no-irregular-whitespace': 'error',
-		'no-trailing-spaces': 'error',
-		'no-undef': 'error',
-		'no-unused-expressions': 'error',
-		'no-unused-vars': [ 'error', { ignoreRestSiblings: true } ],
-		'one-var': [ 'error', 'always' ],
-		quotes: [ 'error', 'single' ],
-		'wrap-iife': [ 'error', 'any' ],
+module.exports = [
+	{
+		rules: {
+			curly: 'error',
+			eqeqeq: 'error',
+			'no-caller': 'error',
+			'no-cond-assign': [ 'error', 'except-parens' ],
+			'no-eq-null': 'error',
+			'no-irregular-whitespace': 'error',
+			'no-trailing-spaces': 'error',
+			'no-undef': 'error',
+			'no-unused-expressions': 'error',
+			'no-unused-vars': [ 'error', { ignoreRestSiblings: true } ],
+			'one-var': [ 'error', 'always' ],
+			quotes: [ 'error', 'single' ],
+			'wrap-iife': [ 'error', 'any' ],
+		},
 	},
-};
+];

package/configs/jsx-a11y.js

@@ -1,19 +1,25 @@
-module.exports = {
-	extends: [ 'plugin:jsx-a11y/recommended' ],
-	plugins: [ 'jsx-a11y' ],
-	rules: {
-		// False positives with `render` props (e.g. `<Text render={ <h1 /> }>…</Text>`).
-		// See https://github.com/WordPress/gutenberg/issues/76501
-		'jsx-a11y/heading-has-content': 'off',
-		'jsx-a11y/label-has-associated-control': [
-			'error',
-			{
-				assert: 'htmlFor',
-			},
-		],
-		'jsx-a11y/media-has-caption': 'off',
-		'jsx-a11y/no-noninteractive-tabindex': 'off',
-		'jsx-a11y/role-has-required-aria-props': 'off',
-		'jsx-quotes': 'error',
+/**
+ * External dependencies
+ */
+const jsxA11yPlugin = require( 'eslint-plugin-jsx-a11y' );
+
+module.exports = [
+	jsxA11yPlugin.flatConfigs.recommended,
+	{
+		rules: {
+			// False positives with `render` props (e.g. `<Text render={ <h1 /> }>…</Text>`).
+			// See https://github.com/WordPress/gutenberg/issues/76501
+			'jsx-a11y/heading-has-content': 'off',
+			'jsx-a11y/label-has-associated-control': [
+				'error',
+				{
+					assert: 'htmlFor',
+				},
+			],
+			'jsx-a11y/media-has-caption': 'off',
+			'jsx-a11y/no-noninteractive-tabindex': 'off',
+			'jsx-a11y/role-has-required-aria-props': 'off',
+			'jsx-quotes': 'error',
+		},
 	},
-};
+];

package/configs/react.js

@@ -1,45 +1,74 @@
-module.exports = {
-	extends: [ 'plugin:react/recommended' ],
-	parserOptions: {
-		ecmaFeatures: {
-			jsx: true,
+/**
+ * External dependencies
+ */
+const { fixupPluginRules } = require( '@eslint/compat' );
+const reactPlugin = require( 'eslint-plugin-react' );
+const reactHooksPlugin = require( 'eslint-plugin-react-hooks' );
+
+/**
+ * Internal dependencies
+ */
+const wpRules = require( '../rules' );
+
+const wpPlugin = { rules: wpRules };
+
+const fixedReactPlugin = fixupPluginRules( reactPlugin );
+
+module.exports = [
+	{
+		plugins: {
+			react: fixedReactPlugin,
 		},
+		rules: reactPlugin.configs.flat.recommended.rules,
+		languageOptions: reactPlugin.configs.flat.recommended.languageOptions,
 	},
-	settings: {
-		react: {
-			version: 'detect',
+	{
+		plugins: {
+			'@wordpress': wpPlugin,
+			'react-hooks': reactHooksPlugin,
 		},
-	},
-	plugins: [ '@wordpress', 'react', 'react-hooks' ],
-	rules: {
-		'@wordpress/no-unused-vars-before-return': [
-			'error',
-			{
-				excludePattern: '^use',
-			},
-		],
-		'react/display-name': 'off',
-		'react/jsx-curly-spacing': [
-			'error',
-			{
-				when: 'always',
-				children: true,
+		languageOptions: {
+			parserOptions: {
+				ecmaFeatures: {
+					jsx: true,
+				},
 			},
-		],
-		'react/jsx-equals-spacing': 'error',
-		'react/jsx-indent': [ 'error', 'tab' ],
-		'react/jsx-indent-props': [ 'error', 'tab' ],
-		'react/jsx-key': 'error',
-		'react/jsx-tag-spacing': 'error',
-		'react/no-children-prop': 'off',
-		'react/prop-types': 'off',
-		'react/react-in-jsx-scope': 'off',
-		'react-hooks/exhaustive-deps': [
-			'warn',
-			{
-				additionalHooks: '^(useSelect|useSuspenseSelect)$',
+		},
+		settings: {
+			react: {
+				version: 'detect',
 			},
-		],
-		'react-hooks/rules-of-hooks': 'error',
+		},
+		rules: {
+			'@wordpress/no-unused-vars-before-return': [
+				'error',
+				{
+					excludePattern: '^use',
+				},
+			],
+			'react/display-name': 'off',
+			'react/jsx-curly-spacing': [
+				'error',
+				{
+					when: 'always',
+					children: true,
+				},
+			],
+			'react/jsx-equals-spacing': 'error',
+			'react/jsx-indent': [ 'error', 'tab' ],
+			'react/jsx-indent-props': [ 'error', 'tab' ],
+			'react/jsx-key': 'error',
+			'react/jsx-tag-spacing': 'error',
+			'react/no-children-prop': 'off',
+			'react/prop-types': 'off',
+			'react/react-in-jsx-scope': 'off',
+			'react-hooks/exhaustive-deps': [
+				'warn',
+				{
+					additionalHooks: '^(useSelect|useSuspenseSelect)$',
+				},
+			],
+			'react-hooks/rules-of-hooks': 'error',
+		},
 	},
-};
+];

package/configs/recommended-with-formatting.js

@@ -1,38 +1,54 @@
-const config = {
-	extends: [
-		require.resolve( './jsx-a11y.js' ),
-		require.resolve( './custom.js' ),
-		require.resolve( './react.js' ),
-		require.resolve( './esnext.js' ),
-		require.resolve( './i18n.js' ),
-	],
-	plugins: [ 'import' ],
-	env: {
-		node: true,
-	},
-	globals: {
-		window: true,
-		document: true,
-		SCRIPT_DEBUG: 'readonly',
-		wp: 'readonly',
-	},
-	settings: {
-		'import/extensions': [ '.js', '.jsx' ],
-		'import/resolver': {
-			typescript: true,
+/**
+ * External dependencies
+ */
+const globals = require( 'globals' );
+const { fixupPluginRules } = require( '@eslint/compat' );
+const importPlugin = fixupPluginRules( require( 'eslint-plugin-import' ) );
+
+/**
+ * Internal dependencies
+ */
+const jsxA11yConfig = require( './jsx-a11y' );
+const customConfig = require( './custom' );
+const reactConfig = require( './react' );
+const esnextConfig = require( './esnext' );
+const i18nConfig = require( './i18n' );
+
+module.exports = [
+	...jsxA11yConfig,
+	...customConfig,
+	...reactConfig,
+	...esnextConfig,
+	...i18nConfig,
+	{
+		plugins: {
+			import: importPlugin,
 		},
-	},
-	rules: {
-		'import/no-extraneous-dependencies': [
-			'error',
-			{
-				peerDependencies: true,
+		languageOptions: {
+			globals: {
+				...globals.node,
+				window: 'writable',
+				document: 'writable',
+				SCRIPT_DEBUG: 'readonly',
+				wp: 'readonly',
 			},
-		],
-		'import/no-unresolved': 'error',
-		'import/default': 'warn',
-		'import/named': 'warn',
+		},
+		settings: {
+			'import/extensions': [ '.js', '.jsx' ],
+			'import/resolver': {
+				typescript: true,
+			},
+		},
+		rules: {
+			'import/no-extraneous-dependencies': [
+				'error',
+				{
+					peerDependencies: true,
+				},
+			],
+			'import/no-unresolved': 'error',
+			'import/default': 'warn',
+			'import/named': 'warn',
+		},
 	},
-};
-
-module.exports = config;
+];

package/configs/recommended.js

@@ -3,52 +3,63 @@
  */
 const { cosmiconfigSync } = require( 'cosmiconfig' );
 
-/**
- * WordPress dependencies
- */
-
 /**
  * Internal dependencies
  */
 const { isPackageInstalled } = require( '../utils' );
+const recommendedWithFormattingConfig = require( './recommended-with-formatting' );
 
-const config = {
-	extends: [ require.resolve( './recommended-with-formatting.js' ) ],
-};
+const config = [ ...recommendedWithFormattingConfig ];
 
 if ( isPackageInstalled( 'prettier' ) ) {
-	config.extends.push( 'plugin:prettier/recommended' );
+	const eslintPluginPrettier = require( 'eslint-plugin-prettier' );
+	const eslintConfigPrettier = require( 'eslint-config-prettier' );
 
 	const { config: localPrettierConfig } =
 		cosmiconfigSync( 'prettier' ).search() || {};
 	const defaultPrettierConfig = require( '@wordpress/prettier-config' );
 	const prettierConfig = { ...defaultPrettierConfig, ...localPrettierConfig };
-	config.rules = {
-		'prettier/prettier': [ 'error', prettierConfig ],
-		// Prettier _disables_ this rule, but we want it!
-		// See https://github.com/prettier/eslint-config-prettier?tab=readme-ov-file#curly
-		// > This rule requires certain options.
-		// > …
-		// > If you like this rule, it can be used just fine with Prettier as long as you don’t use the "multi-line" or "multi-or-nest" option.
-		curly: [ 'error', 'all' ],
-	};
+
+	config.push( eslintConfigPrettier, {
+		plugins: {
+			prettier: eslintPluginPrettier,
+		},
+		rules: {
+			...eslintConfigPrettier.rules,
+			'prettier/prettier': [ 'error', prettierConfig ],
+			// Prettier _disables_ this rule, but we want it!
+			// See https://github.com/prettier/eslint-config-prettier?tab=readme-ov-file#curly
+			// > This rule requires certain options.
+			// > …
+			// > If you like this rule, it can be used just fine with Prettier as long as you don't use the "multi-line" or "multi-or-nest" option.
+			curly: [ 'error', 'all' ],
+		},
+	} );
 }
 
 if ( isPackageInstalled( 'typescript' ) ) {
-	config.settings = {
-		'import/resolver': {
-			typescript: {
-				extensions: [ '.js', '.jsx', '.ts', '.tsx' ],
+	const tseslint = require( 'typescript-eslint' );
+
+	config.push(
+		tseslint.configs.eslintRecommended,
+		{
+			settings: {
+				'import/resolver': {
+					typescript: {
+						extensions: [ '.js', '.jsx', '.ts', '.tsx' ],
+					},
+				},
 			},
+			ignores: [ '**/*.d.ts' ],
 		},
-	};
-	config.extends.push( 'plugin:@typescript-eslint/eslint-recommended' );
-	config.ignorePatterns = [ '**/*.d.ts' ];
-	config.plugins = [ '@typescript-eslint' ];
-	config.overrides = [
 		{
 			files: [ '**/*.ts', '**/*.tsx' ],
-			parser: '@typescript-eslint/parser',
+			languageOptions: {
+				parser: tseslint.parser,
+			},
+			plugins: {
+				'@typescript-eslint': tseslint.plugin,
+			},
 			rules: {
 				'no-duplicate-imports': 'off',
 				'import/no-duplicates': 'error',
@@ -75,8 +86,8 @@ if ( isPackageInstalled( 'typescript' ) ) {
 				'import/default': 'off',
 				'import/named': 'off',
 			},
-		},
-	];
+		}
+	);
 }
 
 module.exports = config;

package/configs/test-e2e.js

@@ -1,11 +1,19 @@
-module.exports = {
-	extends: [ 'plugin:jest/recommended' ],
-	env: {
-		browser: true,
+/**
+ * External dependencies
+ */
+const globals = require( 'globals' );
+const jestPlugin = require( 'eslint-plugin-jest' );
+
+module.exports = [
+	jestPlugin.configs[ 'flat/recommended' ],
+	{
+		languageOptions: {
+			globals: {
+				...globals.browser,
+				browser: 'readonly',
+				page: 'readonly',
+				wp: 'readonly',
+			},
+		},
 	},
-	globals: {
-		browser: 'readonly',
-		page: 'readonly',
-		wp: 'readonly',
-	},
-};
+];

package/configs/test-playwright.js

@@ -1,3 +1,6 @@
-module.exports = {
-	extends: [ 'plugin:playwright/recommended' ],
-};
+/**
+ * External dependencies
+ */
+const playwrightPlugin = require( 'eslint-plugin-playwright' );
+
+module.exports = [ playwrightPlugin.configs[ 'flat/recommended' ] ];

package/configs/test-unit.js

@@ -1,9 +1,16 @@
-module.exports = {
-	extends: [ 'plugin:jest/recommended' ],
-	rules: {
-		'jest/expect-expect': [
-			'error',
-			{ assertFunctionNames: [ 'expect', 'measurePerformance' ] },
-		],
+/**
+ * External dependencies
+ */
+const jestPlugin = require( 'eslint-plugin-jest' );
+
+module.exports = [
+	jestPlugin.configs[ 'flat/recommended' ],
+	{
+		rules: {
+			'jest/expect-expect': [
+				'error',
+				{ assertFunctionNames: [ 'expect', 'measurePerformance' ] },
+			],
+		},
 	},
-};
+];