@wordpress/eslint-plugin 10.0.2 → 11.0.0

package/CHANGELOG.md

@@ -2,7 +2,15 @@
 
 ## Unreleased
 
-–   Replaced no-shadow eslint rule with @typescript-eslint/no-shadow ([#38665](https://github.com/WordPress/gutenberg/pull/38665)).
+## 11.0.0 (2022-03-11)
+
+### Breaking Changes
+
+-   The integration with [Prettier](https://prettier.io) is now optional and gets activated when the `prettier` package is installed in the project ([#39244](https://github.com/WordPress/gutenberg/pull/39244)).
+
+### Bug Fix
+
+-   Replaced no-shadow eslint rule with @typescript-eslint/no-shadow ([#38665](https://github.com/WordPress/gutenberg/pull/38665)).
 
 ## 10.0.0 (2022-01-27)
 

package/README.md

@@ -24,9 +24,21 @@ To opt-in to the default configuration, extend your own project's `.eslintrc` fi
 
 Refer to the [ESLint documentation on Shareable Configs](http://eslint.org/docs/developer-guide/shareable-configs) for more information.
 
-The `recommended` preset will include rules governing an ES2015+ environment, and includes rules from the [`eslint-plugin-jsx-a11y`](https://github.com/evcohen/eslint-plugin-jsx-a11y), [`eslint-plugin-react`](https://github.com/yannickcr/eslint-plugin-react), and [`eslint-plugin-prettier`](https://github.com/prettier/eslint-plugin-prettier) projects. It also includes an optional integration with [`@typescript-eslint/eslint-plugin`](https://github.com/typescript-eslint/typescript-eslint) that gets activated when the [`typescript`](https://www.npmjs.com/package/typescript) package is installed in the project.
+The `recommended` preset will include rules governing an ES2015+ environment, and includes rules from the [`eslint-plugin-jsdoc`](https://github.com/gajus/eslint-plugin-jsdoc), [`eslint-plugin-jsx-a11y`](https://github.com/evcohen/eslint-plugin-jsx-a11y), [`eslint-plugin-react`](https://github.com/yannickcr/eslint-plugin-react), and other similar plugins.
 
-There is also `recommended-with-formatting` ruleset for projects that want to opt out from [Prettier](https://prettier.io). It has the native ESLint code formatting rules enabled instead.
+This preset offers an optional integration with the [`eslint-plugin-prettier`](https://github.com/prettier/eslint-plugin-prettier) package that runs [Prettier](https://prettier.io) code formatter and reports differences as individual ESLint issues. You can activate it by installing the [`prettier`](https://www.npmjs.com/package/prettier) package separately with:
+
+```bash
+npm install prettier --save-dev
+```
+
+Finally, this ruleset also includes an optional integration with the [`@typescript-eslint/eslint-plugin`](https://github.com/typescript-eslint/typescript-eslint) package that enables ESLint to support [TypeScript](https://www.typescriptlang.org) language. You can activate it by installing the [`typescript`](https://www.npmjs.com/package/typescript) package separately with:
+
+```bash
+npm install typescript --save-dev
+```
+
+There is also `recommended-with-formatting` ruleset for projects that want to ensure that [Prettier](https://prettier.io) and [TypeScript](https://www.typescriptlang.org) integration is never activated. This preset has the native ESLint code formatting rules enabled instead.
 
 ### Rulesets
 

package/configs/esnext.js

@@ -16,7 +16,7 @@ const config = {
 		// Disable ES5-specific (extended from ES5)
 		'vars-on-top': 'off',
 
-		// Enable ESNext-specific
+		// Enable ESNext-specific.
 		'arrow-parens': [ 'error', 'always' ],
 		'arrow-spacing': 'error',
 		'computed-property-spacing': [ 'error', 'always' ],

package/configs/recommended.js

@@ -13,20 +13,21 @@ const defaultPrettierConfig = require( '@wordpress/prettier-config' );
  */
 const { isPackageInstalled } = require( '../utils' );
 
-const { config: localPrettierConfig } =
-	cosmiconfigSync( 'prettier' ).search() || {};
-const prettierConfig = { ...defaultPrettierConfig, ...localPrettierConfig };
-
 const config = {
-	extends: [
-		require.resolve( './recommended-with-formatting.js' ),
-		'plugin:prettier/recommended',
-	],
-	rules: {
-		'prettier/prettier': [ 'error', prettierConfig ],
-	},
+	extends: [ require.resolve( './recommended-with-formatting.js' ) ],
 };
 
+if ( isPackageInstalled( 'prettier' ) ) {
+	config.extends.push( 'plugin:prettier/recommended' );
+
+	const { config: localPrettierConfig } =
+		cosmiconfigSync( 'prettier' ).search() || {};
+	const prettierConfig = { ...defaultPrettierConfig, ...localPrettierConfig };
+	config.rules = {
+		'prettier/prettier': [ 'error', prettierConfig ],
+	};
+}
+
 if ( isPackageInstalled( 'typescript' ) ) {
 	config.settings = {
 		'import/resolver': {
@@ -48,7 +49,7 @@ if ( isPackageInstalled( 'typescript' ) ) {
 				// Don't require redundant JSDoc types in TypeScript files.
 				'jsdoc/require-param-type': 'off',
 				'jsdoc/require-returns-type': 'off',
-				// handled by TS itself
+				// Handled by TS itself.
 				'no-unused-vars': 'off',
 				// no-shadow doesn't work correctly in TS, so let's use a TS-dedicated version instead.
 				'no-shadow': 'off',

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/eslint-plugin",
-	"version": "10.0.2",
+	"version": "11.0.0",
 	"description": "ESLint plugin for WordPress development.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -34,7 +34,7 @@
 		"@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.1",
+		"@wordpress/babel-preset-default": "^6.6.0",
 		"@wordpress/prettier-config": "^1.1.2",
 		"cosmiconfig": "^7.0.0",
 		"eslint-config-prettier": "^8.3.0",
@@ -46,15 +46,18 @@
 		"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": {
 		"@babel/core": ">=7",
 		"eslint": ">=8",
+		"prettier": ">=2",
 		"typescript": ">=4"
 	},
 	"peerDependenciesMeta": {
+		"prettier": {
+			"optional": true
+		},
 		"typescript": {
 			"optional": true
 		}
@@ -62,5 +65,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "4566ac290359553d04de4eb574545309343f790b"
+	"gitHead": "c37fd7edbc3e379540d7b24fce75a6f640a434ae"
 }

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

@@ -16,14 +16,14 @@ const ruleTester = new RuleTester( {
 } );
 
 const valid = [
-	// Callback functions
+	// Callback functions.
 	`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
+	// Direct function calls.
 	`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 );`,
@@ -31,7 +31,7 @@ const valid = [
 	`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
+	// Object property function calls.
 	`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 );`,
@@ -54,14 +54,14 @@ const createSuggestionTestCase = ( code, output ) => ( {
 } );
 
 const invalid = [
-	// Callback functions
+	// Callback functions.
 	`import { createRegistrySelector } from '@wordpress/data'; createRegistrySelector(( select ) => { select( 'core' ); });`,
 	`import { useSelect } from '@wordpress/data'; useSelect(( select ) => { select( 'core' ); });`,
 	`import { withSelect } from '@wordpress/data'; withSelect(( select ) => { select( 'core' ); });`,
 	`import { withDispatch } from '@wordpress/data'; withDispatch(( select ) => { select( 'core' ); });`,
 	`import { withDispatch as withDispatchAlias } from '@wordpress/data'; withDispatchAlias(( select ) => { select( 'core' ); });`,
 
-	// Direct function calls
+	// Direct function calls.
 	`import { useDispatch } from '@wordpress/data'; useDispatch( 'core' );`,
 	`import { dispatch } from '@wordpress/data'; dispatch( 'core' );`,
 	`import { useSelect } from '@wordpress/data'; useSelect( 'core' );`,
@@ -69,14 +69,14 @@ const invalid = [
 	`import { resolveSelect } from '@wordpress/data'; resolveSelect( 'core' );`,
 	`import { resolveSelect as resolveSelectAlias } from '@wordpress/data'; resolveSelectAlias( 'core' );`,
 
-	// Object property function calls
+	// Object property function calls.
 	`import { controls } from '@wordpress/data'; controls.select( 'core' );`,
 	`import { controls } from '@wordpress/data'; controls.dispatch( 'core' );`,
 	`import { controls } from '@wordpress/data'; controls.resolveSelect( 'core' );`,
 	`import { controls as controlsAlias } from '@wordpress/data'; controlsAlias.resolveSelect( 'core' );`,
 
 	// Direct function calls suggestions
-	// Replace core with coreStore and import coreStore
+	// Replace core with coreStore and import coreStore.
 	createSuggestionTestCase(
 		`import { select } from '@wordpress/data'; select( 'core' );`,
 		`import { select } from '@wordpress/data';\nimport { store as coreStore } from '@wordpress/core-data'; select( coreStore );`
@@ -103,17 +103,17 @@ const invalid = [
 		`import { a } from './a'; import { select } from '@wordpress/data'; import { b } from './b'; select( 'core' );`,
 		`import { a } from './a'; import { select } from '@wordpress/data';\nimport { store as coreStore } from '@wordpress/core-data'; import { b } from './b'; select( coreStore );`
 	),
-	// Replace block-editor with blockEditorStore
+	// Replace block-editor with blockEditorStore.
 	createSuggestionTestCase(
 		`import { select } from '@wordpress/data'; select( 'core/block-editor' );`,
 		`import { select } from '@wordpress/data';\nimport { store as blockEditorStore } from '@wordpress/block-editor'; select( blockEditorStore );`
 	),
-	// Replace notices with noticesStore
+	// Replace notices with noticesStore.
 	createSuggestionTestCase(
 		`import { select } from '@wordpress/data'; select( 'core/notices' );`,
 		`import { select } from '@wordpress/data';\nimport { store as noticesStore } from '@wordpress/notices'; select( noticesStore );`
 	),
-	// Replace edit-post with editPostStore
+	// Replace edit-post with editPostStore.
 	createSuggestionTestCase(
 		`import { select } from '@wordpress/data'; select( 'core/edit-post' );`,
 		`import { select } from '@wordpress/data';\nimport { store as editPostStore } from '@wordpress/edit-post'; select( editPostStore );`

package/rules/dependency-group.js

@@ -82,7 +82,7 @@ module.exports = {
 			// - Normalize `/**` and `/*`
 			// - Case insensitive "Dependencies" vs. "dependencies"
 			// - Ending period
-			// - "Node" dependencies as an alias for External
+			// - "Node" dependencies as an alias for External.
 
 			if ( locality === 'External' ) {
 				locality = '(External|Node)';

package/rules/gutenberg-phase.js

@@ -80,7 +80,7 @@ function testIsUsedInStrictBinaryExpression( node, context ) {
 		const comparisonNode =
 			node.parent.type === 'MemberExpression' ? node.parent : node;
 
-		// Test for process.env.GUTENBERG_PHASE === <number> or <number> === process.env.GUTENBERG_PHASE
+		// Test for process.env.GUTENBERG_PHASE === <number> or <number> === process.env.GUTENBERG_PHASE.
 		const hasCorrectOperator = [ '===', '!==' ].includes( parent.operator );
 		const hasCorrectOperands =
 			( parent.left === comparisonNode &&

package/rules/i18n-no-variables.js

@@ -18,7 +18,7 @@ function isAcceptableLiteralNode( node ) {
 
 	if ( 'TemplateLiteral' === node.type ) {
 		// Backticks are fine, but if there's any interpolation in it,
-		// that's a problem
+		// that's a problem.
 		return node.expressions.length === 0;
 	}
 

package/rules/i18n-text-domain.js

@@ -141,7 +141,7 @@ module.exports = {
 				) {
 					const replaceTextDomain = ( fixer ) => {
 						return fixer.replaceTextRange(
-							// account for quotes.
+							// Account for quotes.
 							[ range[ 0 ] + 1, range[ 1 ] - 1 ],
 							allowedTextDomains[ 0 ]
 						);

package/rules/no-unsafe-wp-apis.js

@@ -51,7 +51,7 @@ function makeListener( { allowedImports, context } ) {
 
 		const sourceModule = node.source.value.trim();
 
-		// Ignore non-WordPress packages
+		// Ignore non-WordPress packages.
 		if ( ! sourceModule.startsWith( '@wordpress/' ) ) {
 			return;
 		}