@wordpress/eslint-plugin 9.1.2-next.5df0cd52b7.0 → 10.0.0

package/CHANGELOG.md

@@ -2,7 +2,50 @@
 
 ## Unreleased
 
-## 9.1.1-next.0 (2021-08-17)
+## 10.0.0 (2022-01-27)
+
+### Breaking Changes
+
+-   The peer dependency constraint for ESLint has been updated from `^6 || ^7` to `^8`.
+-   The bundled `@typescript-eslint/eslint-plugin` dependency has been updated from requiring `^4.31.0` to requiring `^5.3.0` ([#36283](https://github.com/WordPress/gutenberg/pull/36283)).
+-   The bundled `@typescript-eslint/parser` dependency has been updated from requiring `^4.31.0` to requiring `^5.3.0` ([#36283](https://github.com/WordPress/gutenberg/pull/36283)).
+-   The bundled `eslint-config-prettier` dependency has been updated from requiring `^7.1.0` to requiring `^8.3.0` ([#36283](https://github.com/WordPress/gutenberg/pull/36283)).
+-   The bundled `eslint-plugin-jest` dependency has been updated from requiring `^24.1.3` to requiring `^25.2.3` ([#36283](https://github.com/WordPress/gutenberg/pull/36283)).
+-   The bundled `eslint-plugin-jsdoc` dependency has been updated from requiring `^36.0.8` to requiring `^37.0.3` ([#36283](https://github.com/WordPress/gutenberg/pull/36283)).
+-   The bundled `globals` dependency has been updated from requiring `^12.0.0` to requiring `^13.12.0` ([#36283](https://github.com/WordPress/gutenberg/pull/36283)).
+
+### Enhancement
+
+-   Omit verification for WordPress dependencies in the import statements since they get externalized when used with WordPress ([#37639](https://github.com/WordPress/gutenberg/pull/37639)).
+
+### Bug Fix
+
+-   Fix Babel config resolution when a custom ESLint config present ([#37406](https://github.com/WordPress/gutenberg/pull/37406)). Warning: it won't recognize the `babel.config.json` file present in the project until the upstream bug in `cosmiconfig` is fixed.
+
+## 9.3.0 (2021-11-15)
+
+### Enhancements
+
+-   Replaced deprecated `babel-eslint` dependency with `@babel/eslint-parser` ([#36244](https://github.com/WordPress/gutenberg/pull/36244)).
+-   The bundled `eslint-plugin-import` dependency has been updated from requiring `^2.23.4` to requiring `^2.25.2` ([#36244](https://github.com/WordPress/gutenberg/pull/36244)).
+
+## 9.2.0 (2021-10-12)
+
+### Enhancement
+
+-   The bundled `eslint-plugin-jsdoc` dependency has been updated from requiring `^34.1.0` to requiring `^36.0.8` ([#34338](https://github.com/WordPress/gutenberg/pull/34338)).
+
+### Bug Fix
+
+-   Use Jest related rules only when the `jest` package is installed ([#33120](https://github.com/WordPress/gutenberg/pull/33120)).
+
+## 9.1.2 (2021-09-09)
+
+### Bug Fix
+
+-   The recommended configuration will now respect `type` imports in TypeScript files ([#34055](https://github.com/WordPress/gutenberg/pull/34055)).
+
+## 9.1.1 (2021-08-23)
 
 ### Bug Fix
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 ## Gutenberg
 
-    Copyright 2016-2021 by the contributors
+    Copyright 2016-2022 by the contributors
 
 **License for Contributions (on and after April 15, 2021)**
 

package/README.md

@@ -63,8 +63,9 @@ The granular rulesets will not define any environment globals. As such, if they
 | [gutenberg-phase](docs/rules/gutenberg-phase.md)                                                                     | Governs the use of the `process.env.GUTENBERG_PHASE` constant                                  | ✓           |
 | [no-base-control-with-label-without-id](/packages/eslint-plugin/docs/rules/no-base-control-with-label-without-id.md) | Disallow the usage of BaseControl component with a label prop set but omitting the id property | ✓           |
 | [no-unguarded-get-range-at](/packages/eslint-plugin/docs/rules/no-unguarded-get-range-at.md)                         | Disallow the usage of unguarded `getRangeAt` calls                                             | ✓           |
+| [no-unsafe-wp-apis](/packages/eslint-plugin/docs/rules/no-unsafe-wp-apis.md)                                         | Disallow the usage of unsafe APIs from `@wordpress/*` packages                                 | ✓           |
 | [no-unused-vars-before-return](/packages/eslint-plugin/docs/rules/no-unused-vars-before-return.md)                   | Disallow assigning variable values if unused before a return                                   | ✓           |
-| [react-no-unsafe-timeout](/packages/eslint-plugin/docs/rules/react-no-unsafe-timeout.md)                             | Disallow unsafe `setTimeout` in component                                                      |
+| [react-no-unsafe-timeout](/packages/eslint-plugin/docs/rules/react-no-unsafe-timeout.md)                             | Disallow unsafe `setTimeout` in component                                                      |             |
 | [valid-sprintf](/packages/eslint-plugin/docs/rules/valid-sprintf.md)                                                 | Enforce valid sprintf usage                                                                    | ✓           |
 | [i18n-ellipsis](/packages/eslint-plugin/docs/rules/i18n-ellipsis.md)                                                 | Disallow using three dots in translatable strings                                              | ✓           |
 | [i18n-no-collapsible-whitespace](/packages/eslint-plugin/docs/rules/i18n-no-collapsible-whitespace.md)               | Disallow collapsible whitespace in translatable strings                                        | ✓           |

package/configs/custom.js

@@ -6,7 +6,6 @@ module.exports = {
 		'@wordpress/no-unguarded-get-range-at': 'error',
 		'@wordpress/no-global-active-element': 'error',
 		'@wordpress/no-global-get-selection': 'error',
-		'@wordpress/no-global-event-listener': 'warn',
 		'@wordpress/no-unsafe-wp-apis': 'error',
 	},
 	overrides: [
@@ -25,13 +24,7 @@ module.exports = {
 			rules: {
 				'@wordpress/no-global-active-element': 'off',
 				'@wordpress/no-global-get-selection': 'off',
-				'@wordpress/no-global-event-listener': 'off',
 			},
 		},
 	],
-	settings: {
-		react: {
-			version: '16.6',
-		},
-	},
 };

package/configs/esnext.js

@@ -1,11 +1,17 @@
-module.exports = {
+/**
+ * External dependencies
+ */
+const { cosmiconfigSync } = require( 'cosmiconfig' );
+
+const config = {
+	parser: '@babel/eslint-parser',
+	parserOptions: {
+		sourceType: 'module',
+	},
 	env: {
 		es6: true,
 	},
 	extends: [ require.resolve( './es5.js' ) ],
-	parserOptions: {
-		sourceType: 'module',
-	},
 	rules: {
 		// Disable ES5-specific (extended from ES5)
 		'vars-on-top': 'off',
@@ -45,3 +51,18 @@ module.exports = {
 		'template-curly-spacing': [ 'error', 'always' ],
 	},
 };
+
+// It won't recognize the `babel.config.json` file used in the project until the upstream bug in `cosmiconfig` is fixed:
+// https://github.com/davidtheclark/cosmiconfig/issues/246.
+const result = cosmiconfigSync( 'babel' ).search();
+if ( ! result || ! result.filepath ) {
+	config.parserOptions = {
+		...config.parserOptions,
+		requireConfigFile: false,
+		babelOptions: {
+			presets: [ require.resolve( '@wordpress/babel-preset-default' ) ],
+		},
+	};
+}
+
+module.exports = config;

package/configs/jsdoc.js

@@ -105,6 +105,11 @@ module.exports = {
 		'jsdoc/require-param-description': 'off',
 		'jsdoc/require-returns': 'off',
 		'jsdoc/require-yields': 'off',
+		'jsdoc/tag-lines': 'off',
+		'jsdoc/no-multi-asterisks': [
+			'error',
+			{ preventAtMiddleLines: false },
+		],
 		'jsdoc/check-access': 'error',
 		'jsdoc/check-alignment': 'error',
 		'jsdoc/check-line-alignment': [

package/configs/react.js

@@ -6,7 +6,9 @@ module.exports = {
 		},
 	},
 	settings: {
-		'import/extensions': [ '.js', '.jsx' ],
+		react: {
+			version: 'detect',
+		},
 	},
 	plugins: [ '@wordpress', 'react', 'react-hooks' ],
 	rules: {

package/configs/recommended-with-formatting.js

@@ -1,5 +1,12 @@
-module.exports = {
-	parser: 'babel-eslint',
+/**
+ * Internal dependencies
+ */
+const { isPackageInstalled } = require( '../utils' );
+
+// Exclude bundled WordPress packages from the list.
+const wpPackagesRegExp = '^@wordpress/(?!(icons|interface))';
+
+const config = {
 	extends: [
 		require.resolve( './jsx-a11y.js' ),
 		require.resolve( './custom.js' ),
@@ -16,6 +23,10 @@ module.exports = {
 		document: true,
 		wp: 'readonly',
 	},
+	settings: {
+		'import/internal-regex': wpPackagesRegExp,
+		'import/extensions': [ '.js', '.jsx' ],
+	},
 	rules: {
 		'import/no-extraneous-dependencies': [
 			'error',
@@ -23,11 +34,19 @@ module.exports = {
 				peerDependencies: true,
 			},
 		],
-		'import/no-unresolved': 'error',
+		'import/no-unresolved': [
+			'error',
+			{
+				ignore: [ wpPackagesRegExp ],
+			},
+		],
 		'import/default': 'warn',
 		'import/named': 'warn',
 	},
-	overrides: [
+};
+
+if ( isPackageInstalled( 'jest' ) ) {
+	config.overrides = [
 		{
 			// Unit test files and their helpers only.
 			files: [ '**/@(test|__tests__)/**/*.js', '**/?(*.)test.js' ],
@@ -38,5 +57,7 @@ module.exports = {
 			files: [ '**/specs/**/*.js', '**/?(*.)spec.js' ],
 			extends: [ require.resolve( './test-e2e.js' ) ],
 		},
-	],
-};
+	];
+}
+
+module.exports = config;

package/configs/recommended.js

@@ -21,7 +21,6 @@ const config = {
 	extends: [
 		require.resolve( './recommended-with-formatting.js' ),
 		'plugin:prettier/recommended',
-		'prettier/react',
 	],
 	rules: {
 		'prettier/prettier': [ 'error', prettierConfig ],
@@ -35,15 +34,17 @@ if ( isPackageInstalled( 'typescript' ) ) {
 				extensions: [ '.js', '.jsx', '.ts', '.tsx' ],
 			},
 		},
-		'import/core-modules': [ 'react' ],
 	};
 	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',
 			rules: {
+				'no-duplicate-imports': 'off',
+				'@typescript-eslint/no-duplicate-imports': 'error',
 				// Don't require redundant JSDoc types in TypeScript files.
 				'jsdoc/require-param-type': 'off',
 				'jsdoc/require-returns-type': 'off',

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/eslint-plugin",
-	"version": "9.1.2-next.5df0cd52b7.0",
+	"version": "10.0.0",
 	"description": "ESLint plugin for WordPress development.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -31,26 +31,28 @@
 	],
 	"main": "index.js",
 	"dependencies": {
-		"@typescript-eslint/eslint-plugin": "^4.15.0",
-		"@typescript-eslint/parser": "^4.15.0",
-		"@wordpress/prettier-config": "^1.1.1-next.5df0cd52b7.0",
-		"babel-eslint": "^10.1.0",
+		"@babel/eslint-parser": "^7.16.0",
+		"@typescript-eslint/eslint-plugin": "^5.3.0",
+		"@typescript-eslint/parser": "^5.3.0",
+		"@wordpress/babel-preset-default": "^6.5.0",
+		"@wordpress/prettier-config": "^1.1.1",
 		"cosmiconfig": "^7.0.0",
-		"eslint-config-prettier": "^7.1.0",
-		"eslint-plugin-import": "^2.23.4",
-		"eslint-plugin-jest": "^24.1.3",
-		"eslint-plugin-jsdoc": "^34.1.0",
-		"eslint-plugin-jsx-a11y": "^6.4.1",
+		"eslint-config-prettier": "^8.3.0",
+		"eslint-plugin-import": "^2.25.2",
+		"eslint-plugin-jest": "^25.2.3",
+		"eslint-plugin-jsdoc": "^37.0.3",
+		"eslint-plugin-jsx-a11y": "^6.5.1",
 		"eslint-plugin-prettier": "^3.3.0",
-		"eslint-plugin-react": "^7.22.0",
-		"eslint-plugin-react-hooks": "^4.2.0",
-		"globals": "^12.0.0",
+		"eslint-plugin-react": "^7.27.0",
+		"eslint-plugin-react-hooks": "^4.3.0",
+		"globals": "^13.12.0",
 		"prettier": "npm:wp-prettier@2.2.1-beta-1",
 		"requireindex": "^1.2.0"
 	},
 	"peerDependencies": {
-		"eslint": "^6 || ^7",
-		"typescript": "^4"
+		"@babel/core": ">=7",
+		"eslint": ">=8",
+		"typescript": ">=4"
 	},
 	"peerDependenciesMeta": {
 		"typescript": {
@@ -60,5 +62,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "558d577d12bec15f05e694eb49a094836d885cca"
+	"gitHead": "d95ccb9366e249133cdb1d7b25c382446b9ee502"
 }

package/rules/__tests__/data-no-store-string-literals.js

@@ -17,24 +17,25 @@ const ruleTester = new RuleTester( {
 
 const valid = [
 	// Callback functions
-	`import { createRegistrySelector } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; createRegistrySelector(( select ) => { select(store); });`,
-	`import { useSelect } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; useSelect(( select ) => { select(store); });`,
-	`import { withSelect } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; withSelect(( select ) => { select(store); });`,
-	`import { withDispatch } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; withDispatch(( select ) => { select(store); });`,
-	`import { withDispatch as withDispatchAlias } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; withDispatchAlias(( select ) => { select(store); });`,
+	`import { createRegistrySelector } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; createRegistrySelector(( select ) => { select(coreStore); });`,
+	`import { useSelect } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; useSelect(( select ) => { select(coreStore); });`,
+	`import { withSelect } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; withSelect(( select ) => { select(coreStore); });`,
+	`import { withDispatch } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; withDispatch(( select ) => { select(coreStore); });`,
+	`import { withDispatch as withDispatchAlias } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; withDispatchAlias(( select ) => { select(coreStore); });`,
 
 	// Direct function calls
-	`import { useDispatch } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; useDispatch( store );`,
-	`import { dispatch } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; dispatch( store );`,
-	`import { select } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; select( store );`,
-	`import { resolveSelect } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; resolveSelect( store );`,
-	`import { resolveSelect as resolveSelectAlias } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; resolveSelectAlias( store );`,
+	`import { useDispatch } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; useDispatch( coreStore );`,
+	`import { dispatch } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; dispatch( coreStore );`,
+	`import { useSelect } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; useSelect( coreStore );`,
+	`import { select } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; select( coreStore );`,
+	`import { resolveSelect } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; resolveSelect( coreStore );`,
+	`import { resolveSelect as resolveSelectAlias } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; resolveSelectAlias( coreStore );`,
 
 	// Object property function calls
-	`import { controls } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; controls.select( store );`,
-	`import { controls } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; controls.dispatch( store );`,
-	`import { controls } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; controls.resolveSelect( store );`,
-	`import { controls as controlsAlias } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; controlsAlias.resolveSelect( store );`,
+	`import { controls } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; controls.select( coreStore );`,
+	`import { controls } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; controls.dispatch( coreStore );`,
+	`import { controls } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; controls.resolveSelect( coreStore );`,
+	`import { controls as controlsAlias } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; controlsAlias.resolveSelect( coreStore );`,
 ];
 
 const createSuggestionTestCase = ( code, output ) => ( {
@@ -63,6 +64,7 @@ const invalid = [
 	// Direct function calls
 	`import { useDispatch } from '@wordpress/data'; useDispatch( 'core' );`,
 	`import { dispatch } from '@wordpress/data'; dispatch( 'core' );`,
+	`import { useSelect } from '@wordpress/data'; useSelect( 'core' );`,
 	`import { select } from '@wordpress/data'; select( 'core' );`,
 	`import { resolveSelect } from '@wordpress/data'; resolveSelect( 'core' );`,
 	`import { resolveSelect as resolveSelectAlias } from '@wordpress/data'; resolveSelectAlias( 'core' );`,

package/rules/data-no-store-string-literals.js

@@ -78,9 +78,13 @@ function collectAllNodesFromDirectFunctionCalls( context, node ) {
 	const specifiers = node.specifiers.filter(
 		( specifier ) =>
 			specifier.imported &&
-			[ 'useDispatch', 'dispatch', 'select', 'resolveSelect' ].includes(
-				specifier.imported.name
-			)
+			[
+				'useDispatch',
+				'dispatch',
+				'useSelect',
+				'select',
+				'resolveSelect',
+			].includes( specifier.imported.name )
 	);
 	const references = getReferences( context, specifiers );
 	const possibleCallExpressionNodes = references
@@ -194,6 +198,7 @@ function getFixes( fixer, context, callNode ) {
 module.exports = {
 	meta: {
 		type: 'problem',
+		hasSuggestions: true,
 		schema: [],
 		messages: {
 			doNotUseStringLiteral: `Do not use string literals ( '{{ argument }}' ) for accessing @wordpress/data stores. Pass the store definition instead`,

package/rules/__tests__/no-global-event-listener.js

@@ -1,70 +0,0 @@
-/**
- * External dependencies
- */
-import { RuleTester } from 'eslint';
-
-/**
- * Internal dependencies
- */
-import rule from '../no-global-event-listener';
-
-const ruleTester = new RuleTester( {
-	parserOptions: {
-		ecmaVersion: 6,
-	},
-} );
-
-ruleTester.run( 'no-global-event-listener', rule, {
-	valid: [
-		{
-			code: 'ownerDocument.addEventListener();',
-		},
-		{
-			code: 'ownerDocument.removeEventListener();',
-		},
-		{
-			code: 'defaultView.addEventListener();',
-		},
-		{
-			code: 'defaultView.removeEventListener();',
-		},
-	],
-	invalid: [
-		{
-			code: 'document.addEventListener();',
-			errors: [
-				{
-					message:
-						'Avoid using (add|remove)EventListener with globals. Use `ownerDocument` or `ownerDocument.defaultView` on a node ref instead.',
-				},
-			],
-		},
-		{
-			code: 'document.removeEventListener();',
-			errors: [
-				{
-					message:
-						'Avoid using (add|remove)EventListener with globals. Use `ownerDocument` or `ownerDocument.defaultView` on a node ref instead.',
-				},
-			],
-		},
-		{
-			code: 'window.addEventListener();',
-			errors: [
-				{
-					message:
-						'Avoid using (add|remove)EventListener with globals. Use `ownerDocument` or `ownerDocument.defaultView` on a node ref instead.',
-				},
-			],
-		},
-		{
-			code: 'window.removeEventListener();',
-			errors: [
-				{
-					message:
-						'Avoid using (add|remove)EventListener with globals. Use `ownerDocument` or `ownerDocument.defaultView` on a node ref instead.',
-				},
-			],
-		},
-	],
-} );

package/rules/no-global-event-listener.js

@@ -1,35 +0,0 @@
-module.exports = {
-	meta: {
-		type: 'problem',
-		schema: [],
-	},
-	create( context ) {
-		return {
-			CallExpression( node ) {
-				const { callee } = node;
-				const { object, property } = callee;
-
-				if ( ! object || ! property ) {
-					return;
-				}
-
-				if ( object.name !== 'document' && object.name !== 'window' ) {
-					return;
-				}
-
-				if (
-					property.name !== 'addEventListener' &&
-					property.name !== 'removeEventListener'
-				) {
-					return;
-				}
-
-				context.report( {
-					node,
-					message:
-						'Avoid using (add|remove)EventListener with globals. Use `ownerDocument` or `ownerDocument.defaultView` on a node ref instead.',
-				} );
-			},
-		};
-	},
-};