@automattic/eslint-plugin-wpvip 0.5.3 → 0.5.5

package/README.md

@@ -33,8 +33,6 @@ You may also wish to define an `.eslintignore` file if there are files or paths
 
 The "recommended" config includes rules for JavaScript, TypeScript, Jest, and React, including rules related to formatting and white space. It is intended to be strict! Opinionated defaults keep our codebases consistent and reduce the friction we experience when context-switching between projects.
 
-If your project has installed [Prettier](https://prettier.io/) as a dependency, then many formatting tasks will be delegated to it (via `eslint-plugin-prettier`). You are encouraged to define your own [`.prettierrc` configuration file](https://prettier.io/docs/en/configuration.html) to fine-tune your project’s formatting.
-
 Of course, this recommended config may not be ideal for every project, so feel free to "build your own" using the available modular configs. The recommended config is equivalent to:
 
 ```js
@@ -52,6 +50,22 @@ module.exports = {
 
 Note that the order of configs can matter, since they can contain overrides. It is particularly important to add the `prettier` config last.
 
+### Prettier
+
+Install [WP Prettier](https://github.com/Automattic/wp-prettier) to benefit from additional formatting rules:
+
+```sh
+npm i --save-dev --save-exact "prettier@npm:wp-prettier@latest"
+```
+
+This repo also provides a Prettier config, which you can use with the following `.prettierrc`:
+
+```json
+"@automattic/eslint-plugin-wpvip/prettierrc"
+```
+
+For maximum benefit, see [Prettier's documentation on enabling format-on-save in your editor](https://prettier.io/docs/en/editors.html). This enables you to concentrate on coding while Prettier handles formatting.
+
 ## CLI
 
 The `cli` config allows certain behaviors that are usually against best practice but are useful in a codebase that produces a CLI tool:
@@ -94,4 +108,4 @@ This plugin provides a few so-called "weak" configs for legacy codebases that ar
 
 These configs are intended for temporary use and should not be used long-term. We also do not recommend the use of tools like [eslines](https://github.com/Automattic/eslines) to ignore errors or warnings. While the intention is to prevent large-scale changes and transition slowly to stronger standards, the effect is usually that the transition stalls and eventually stops completely.
 
-Three "weak" configs are available: `weak-javascript`, `weak-typescript`, and `weak-jest`. While pull requests on this project are always welcome, please carefully consider whether adding rules to these configs is truly necessary. Ideally, we work to remove rules from these configs until they are no longer needed.
+Three "weak" configs are available: `weak-javascript`, `weak-typescript`, and `weak-testing`. While pull requests on this project are always welcome, please carefully consider whether adding rules to these configs is truly necessary. Ideally, we work to remove rules from these configs until they are no longer needed.

package/configs/base.js

@@ -1 +1 @@
-module.exports = require('./javascript');
+module.exports = require( './javascript' );

package/configs/formatting.js

@@ -4,13 +4,13 @@ module.exports = {
 	 * disable errors, include a brief justification or reasoning.
 	 */
 	rules: {
-		'array-bracket-spacing': ['error', 'always'],
+		'array-bracket-spacing': [ 'error', 'always' ],
 
-		'arrow-parens': ['error', 'always'],
+		'arrow-parens': [ 'error', 'always' ],
 
 		'arrow-spacing': 'error',
 
-		'brace-style': ['error', '1tbs'],
+		'brace-style': [ 'error', '1tbs' ],
 
 		// Identifiers should be in camelCase. Object properties are excluded
 		// (including when destructuring) since they often come from external
@@ -23,24 +23,24 @@ module.exports = {
 			},
 		],
 
-		'comma-dangle': ['error', 'always-multiline'],
+		'comma-dangle': [ 'error', 'always-multiline' ],
 
 		'comma-spacing': 'error',
 
-		'comma-style': ['error', 'last'],
+		'comma-style': [ 'error', 'last' ],
 
-		'computed-property-spacing': ['error', 'always'],
+		'computed-property-spacing': [ 'error', 'always' ],
 
-		curly: ['error', 'all'],
+		curly: [ 'error', 'all' ],
 
 		'dot-notation': 'error',
 
 		// Files must end in a newline.
-		'eol-last': ['error', 'always'],
+		'eol-last': [ 'error', 'always' ],
 
 		'func-call-spacing': 'error',
 
-		indent: ['error', 'tab', { SwitchCase: 1 }],
+		indent: [ 'error', 'tab', { SwitchCase: 1 } ],
 
 		'key-spacing': 'error',
 
@@ -58,51 +58,47 @@ module.exports = {
 
 		'no-multi-str': 'error',
 
-		'no-multiple-empty-lines': ['error', { max: 1 }],
+		'no-multiple-empty-lines': [ 'error', { max: 1 } ],
 
 		'no-trailing-spaces': 'error',
 
 		'no-whitespace-before-property': 'error',
 
-		'object-curly-spacing': ['error', 'always'],
+		'object-curly-spacing': [ 'error', 'always' ],
 
 		'object-shorthand': 'error',
 
 		'operator-linebreak': 'error',
 
-		'padded-blocks': ['error', 'never'],
+		'padded-blocks': [ 'error', 'never' ],
 
 		// Arrow functions should be used for function arguments and callbacks.
 		'prefer-arrow-callback': 'warn',
 
-		quotes: [
-			'error',
-			'single',
-			{ allowTemplateLiterals: true, avoidEscape: true },
-		],
+		quotes: [ 'error', 'single', { allowTemplateLiterals: true, avoidEscape: true } ],
 
-		'quote-props': ['error', 'as-needed'],
+		'quote-props': [ 'error', 'as-needed' ],
 
 		semi: 'error',
 
 		'semi-spacing': 'error',
 
-		'space-before-blocks': ['error', 'always'],
+		'space-before-blocks': [ 'error', 'always' ],
 
 		'space-before-function-paren': [
 			'error',
 			{ anonymous: 'never', named: 'never', asyncArrow: 'always' },
 		],
 
-		'space-in-parens': ['error', 'always'],
+		'space-in-parens': [ 'error', 'always' ],
 
 		'space-infix-ops': 'error',
 
-		'space-unary-ops': ['error', { overrides: { '!': true, yield: true } }],
+		'space-unary-ops': [ 'error', { overrides: { '!': true, yield: true } } ],
 
 		// Comments should always include consistent spacing for readability.
 		'spaced-comment': 'warn',
 
-		'template-curly-spacing': ['error', 'always'],
+		'template-curly-spacing': [ 'error', 'always' ],
 	},
 };

package/configs/index.js

@@ -1,15 +1,15 @@
 module.exports = {
-	base: require('./base'), // synonym for javascript
-	cli: require('./cli'),
-	formatting: require('./formatting'),
-	javascript: require('./javascript'),
-	jsdoc: require('./jsdoc'),
-	prettier: require('./prettier'),
-	react: require('./react'),
-	recommended: require('./recommended'),
-	testing: require('./testing'),
-	typescript: require('./typescript'),
-	'weak-javascript': require('./weak-javascript'),
-	'weak-testing': require('./weak-testing'),
-	'weak-typescript': require('./weak-typescript'),
+	base: require( './base' ), // synonym for javascript
+	cli: require( './cli' ),
+	formatting: require( './formatting' ),
+	javascript: require( './javascript' ),
+	jsdoc: require( './jsdoc' ),
+	prettier: require( './prettier' ),
+	react: require( './react' ),
+	recommended: require( './recommended' ),
+	testing: require( './testing' ),
+	typescript: require( './typescript' ),
+	'weak-javascript': require( './weak-javascript' ),
+	'weak-testing': require( './weak-testing' ),
+	'weak-typescript': require( './weak-typescript' ),
 };

package/configs/javascript.js

@@ -12,7 +12,7 @@ module.exports = {
 		node: true,
 	},
 
-	extends: ['plugin:json/recommended', 'plugin:security/recommended'],
+	extends: [ 'plugin:json/recommended', 'plugin:security/recommended' ],
 
 	parser: '@babel/eslint-parser',
 
@@ -24,7 +24,7 @@ module.exports = {
 	/**
 	 * Note: We must explicitly add this plugin to use our custom rules.
 	 */
-	plugins: ['@automattic/wpvip', 'import'],
+	plugins: [ '@automattic/wpvip', 'import' ],
 
 	/**
 	 * Please include a short description of the rule. For rules that downgrade or
@@ -135,7 +135,7 @@ module.exports = {
 
 		// Enforce Unix linebreaks. Included here and not in "formatting" since it
 		// is not controversial and helps with interchange.
-		'linebreak-style': ['error', 'unix'],
+		'linebreak-style': [ 'error', 'unix' ],
 
 		'no-alert': 'error',
 
@@ -147,7 +147,7 @@ module.exports = {
 
 		'no-caller': 'error',
 
-		'no-cond-assign': ['error', 'except-parens'],
+		'no-cond-assign': [ 'error', 'except-parens' ],
 
 		// `console.log` should not be used directly in code. Ideally, delegate to a
 		// logging function that logs on your behalf (and ignore this rule there).
@@ -159,7 +159,7 @@ module.exports = {
 
 		'no-else-return': 'error',
 
-		'no-empty': ['error', { allowEmptyCatch: true }],
+		'no-empty': [ 'error', { allowEmptyCatch: true } ],
 
 		'no-eq-null': 'error',
 
@@ -177,7 +177,7 @@ module.exports = {
 
 		'no-unused-expressions': 'error',
 
-		'no-unused-vars': ['error', { ignoreRestSiblings: true }],
+		'no-unused-vars': [ 'error', { ignoreRestSiblings: true } ],
 
 		'no-useless-computed-key': 'error',
 
@@ -187,9 +187,9 @@ module.exports = {
 
 		'no-var': 'error',
 
-		'one-var': ['error', 'never'],
+		'one-var': [ 'error', 'never' ],
 
-		'prefer-const': ['error', { destructuring: 'all' }],
+		'prefer-const': [ 'error', { destructuring: 'all' } ],
 
 		radix: 'error',
 
@@ -201,13 +201,13 @@ module.exports = {
 			},
 		],
 
-		'wrap-iife': ['error', 'any'],
+		'wrap-iife': [ 'error', 'any' ],
 	},
 
 	settings: {
 		'import/resolver': {
 			node: {
-				extensions: ['.js', '.jsx', '.ts', '.tsx'],
+				extensions: [ '.js', '.jsx', '.ts', '.tsx' ],
 			},
 			typescript: 'eslint-import-resolver-typescript',
 		},

package/configs/jsdoc.js

@@ -3,7 +3,7 @@
  * https://github.com/WordPress/gutenberg/blob/%40wordpress/eslint-plugin%4014.1.0/packages/eslint-plugin/configs/jsdoc.js
  */
 
-const globals = require('globals');
+const globals = require( 'globals' );
 
 /**
  * Helpful utilities that are globally defined and known to the TypeScript compiler.
@@ -41,7 +41,7 @@ const typescriptUtilityTypes = [
 ];
 
 module.exports = {
-	extends: ['plugin:jsdoc/recommended'],
+	extends: [ 'plugin:jsdoc/recommended' ],
 	settings: {
 		jsdoc: {
 			preferredTypes: {
@@ -61,7 +61,7 @@ module.exports = {
 					// 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((key) => /^[A-Z]/.test(key)),
+					...Object.keys( globals.browser ).filter( key => /^[A-Z]/.test( key ) ),
 					...typescriptUtilityTypes,
 					'void',
 					'JSX',
@@ -73,14 +73,14 @@ module.exports = {
 		'jsdoc/require-returns': 'off',
 		'jsdoc/require-yields': 'off',
 		'jsdoc/tag-lines': 'off',
-		'jsdoc/no-multi-asterisks': ['error', { preventAtMiddleLines: 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'],
+				tags: [ 'param', 'arg', 'argument', 'property', 'prop' ],
 				preserveMainDescriptionPostDelimiter: true,
 			},
 		],

package/configs/prettier.js

@@ -4,8 +4,8 @@
  */
 
 module.exports = {
-	extends: ['plugin:prettier/recommended'],
-	plugins: ['prettier'],
+	extends: [ 'plugin:prettier/recommended' ],
+	plugins: [ 'prettier' ],
 	rules: {
 		'prettier/prettier': 'error',
 	},

package/configs/react.js

@@ -22,7 +22,7 @@ module.exports = {
 		},
 	},
 
-	plugins: ['@automattic/wpvip', 'jsx-a11y', 'react', 'react-hooks'],
+	plugins: [ '@automattic/wpvip', 'jsx-a11y', 'react', 'react-hooks' ],
 
 	rules: {
 		'jsx-a11y/label-has-associated-control': [
@@ -52,9 +52,9 @@ module.exports = {
 
 		'react/jsx-equals-spacing': 'error',
 
-		'react/jsx-indent': ['error', 'tab'],
+		'react/jsx-indent': [ 'error', 'tab' ],
 
-		'react/jsx-indent-props': ['error', 'tab'],
+		'react/jsx-indent-props': [ 'error', 'tab' ],
 
 		'react/jsx-key': 'error',
 

package/configs/recommended.js

@@ -1,28 +1,28 @@
-const debugLog = require('../utils/debug-log');
-const isPackageInstalled = require('../utils/is-package-installed');
+const debugLog = require( '../utils/debug-log' );
+const isPackageInstalled = require( '../utils/is-package-installed' );
 
 const config = {
-	extends: [require.resolve('./javascript')],
+	extends: [ require.resolve( './javascript' ) ],
 };
 
-if (isPackageInstalled('typescript')) {
-	config.extends.push(require.resolve('./typescript'));
+if ( isPackageInstalled( 'typescript' ) ) {
+	config.extends.push( require.resolve( './typescript' ) );
 }
 
-config.extends.push(require.resolve('./formatting'));
+config.extends.push( require.resolve( './formatting' ) );
 
-if (isPackageInstalled('jest')) {
-	config.extends.push(require.resolve('./testing'));
+if ( isPackageInstalled( 'jest' ) ) {
+	config.extends.push( require.resolve( './testing' ) );
 }
 
-if (isPackageInstalled('react')) {
-	config.extends.push(require.resolve('./react'));
+if ( isPackageInstalled( 'react' ) ) {
+	config.extends.push( require.resolve( './react' ) );
 }
 
-if (isPackageInstalled('prettier')) {
-	config.extends.push(require.resolve('./prettier'));
+if ( isPackageInstalled( 'prettier' ) ) {
+	config.extends.push( require.resolve( './prettier' ) );
 }
 
-debugLog(`Using the following configs:\n${config.extends.join('\n')}`);
+debugLog( `Using the following configs:\n${ config.extends.join( '\n' ) }` );
 
 module.exports = config;

package/configs/testing.js

@@ -5,11 +5,11 @@
  */
 
 module.exports = {
-	extends: ['plugin:jest/recommended'],
+	extends: [ 'plugin:jest/recommended' ],
 
 	env: {
 		'jest/globals': true,
 	},
 
-	plugins: ['jest'],
+	plugins: [ 'jest' ],
 };

package/configs/typescript.js

@@ -4,7 +4,7 @@
  */
 
 module.exports = {
-	ignorePatterns: ['**/*.d.ts'],
+	ignorePatterns: [ '**/*.d.ts' ],
 
 	overrides: [
 		{
@@ -14,7 +14,7 @@ module.exports = {
 				'plugin:@typescript-eslint/strict',
 			],
 
-			files: ['**/*.ts', '**/*.tsx'],
+			files: [ '**/*.ts', '**/*.tsx' ],
 
 			parser: '@typescript-eslint/parser',
 
@@ -58,5 +58,5 @@ module.exports = {
 		},
 	],
 
-	plugins: ['@typescript-eslint', 'jsdoc'],
+	plugins: [ '@typescript-eslint', 'jsdoc' ],
 };

package/configs/weak-javascript.js

@@ -10,7 +10,7 @@ module.exports = {
 	overrides: [
 		{
 			// Don't apply weak rules to TypeScript files.
-			files: ['**/*.js', '**/*.jsx'],
+			files: [ '**/*.js', '**/*.jsx' ],
 
 			/**
 			 * Downgrade rules from the base preset to "warn". Do not disable rules (set

package/configs/weak-typescript.js

@@ -7,7 +7,7 @@
 module.exports = {
 	overrides: [
 		{
-			files: ['**/*.ts', '**/*.tsx'],
+			files: [ '**/*.ts', '**/*.tsx' ],
 
 			/**
 			 * Downgrade rules from the base preset to "warn". Do not disable rules (set

package/index.js

@@ -1,4 +1,4 @@
 module.exports = {
-	configs: require('./configs'),
-	rules: require('./rules'),
+	configs: require( './configs' ),
+	rules: require( './rules' ),
 };

package/init.js

@@ -1 +1 @@
-require('@rushstack/eslint-patch/modern-module-resolution');
+require( '@rushstack/eslint-patch/modern-module-resolution' );

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@automattic/eslint-plugin-wpvip",
-  "version": "0.5.3",
+  "version": "0.5.5",
   "description": "ESLint plugin for internal WordPress VIP projects",
   "main": "index.js",
   "scripts": {
     "check-types": "tsc __tests__/**/*.ts",
+    "format": "prettier --ignore-path .gitignore --ignore-path .prettierignore --write '**/*.{js,ts}'",
     "jest": "npm run link-plugin && jest",
     "jest:update-snapshot": "jest --updateSnapshot",
     "link-plugin": "mkdir -p ./node_modules/@automattic; ln -fns $(pwd) ./node_modules/@automattic/eslint-plugin-wpvip",
@@ -53,7 +54,7 @@
     "@types/jest": "29.5.0",
     "eslint": "8.35.0",
     "jest": "29.5.0",
-    "prettier": "2.8.4",
+    "prettier": "npm:wp-prettier@2.8.5",
     "ts-jest": "29.0.5",
     "typescript": "4.9.5"
   }

package/prettierrc.js

@@ -0,0 +1,11 @@
+module.exports = {
+	arrowParens: 'avoid',
+	bracketSpacing: true,
+	jsxBracketSameLine: false,
+	parenSpacing: true,
+	printWidth: 100,
+	semi: true,
+	singleQuote: true,
+	trailingComma: 'es5',
+	useTabs: true,
+};

package/rules/dependency-group.js

@@ -17,7 +17,7 @@ module.exports = {
 		schema: [],
 		fixable: 'code',
 	},
-	create(context) {
+	create( context ) {
 		const comments = context.getSourceCode().getAllComments();
 
 		/**
@@ -45,8 +45,8 @@ module.exports = {
 		 *
 		 * @return {string} Expected comment node value.
 		 */
-		function getCommentValue(locality) {
-			return `*\n * ${locality} dependencies\n `;
+		function getCommentValue( locality ) {
+			return `*\n * ${ locality } dependencies\n `;
 		}
 
 		/**
@@ -57,10 +57,10 @@ module.exports = {
 		 *
 		 * @return {WPPackageLocality} Package locality.
 		 */
-		function getPackageLocality(source) {
-			if (source.startsWith('.')) {
+		function getPackageLocality( source ) {
+			if ( source.startsWith( '.' ) ) {
 				return 'Internal';
-			} else if (source.startsWith('@wordpress/')) {
+			} else if ( source.startsWith( '@wordpress/' ) ) {
 				return 'WordPress';
 			}
 
@@ -76,9 +76,9 @@ module.exports = {
 		 *
 		 * @return {boolean} Whether comment node satisfies locality.
 		 */
-		function isLocalityDependencyBlock(node, locality) {
+		function isLocalityDependencyBlock( node, locality ) {
 			const { type, value } = node;
-			if (type !== 'Block') {
+			if ( type !== 'Block' ) {
 				return false;
 			}
 
@@ -88,16 +88,13 @@ module.exports = {
 			// - Ending period
 			// - "Node" dependencies as an alias for External.
 
-			if (locality === 'External') {
+			if ( locality === 'External' ) {
 				locality = '(External|Node)';
 			}
 
 			// eslint-disable-next-line security/detect-non-literal-regexp
-			const pattern = new RegExp(
-				`^\\*?\\n \\* ${locality} dependencies\\.?\\n $`,
-				'i'
-			);
-			return pattern.test(value);
+			const pattern = new RegExp( `^\\*?\\n \\* ${ locality } dependencies\\.?\\n $`, 'i' );
+			return pattern.test( value );
 		}
 
 		/**
@@ -109,12 +106,12 @@ module.exports = {
 		 *
 		 * @return {boolean} Whether node occurs before reference.
 		 */
-		function isBefore(node, reference) {
-			if (!node.range || !reference.range) {
+		function isBefore( node, reference ) {
+			if ( ! node.range || ! reference.range ) {
 				return false;
 			}
 
-			return node.range[0] < reference.range[0];
+			return node.range[ 0 ] < reference.range[ 0 ];
 		}
 
 		/**
@@ -128,22 +125,22 @@ module.exports = {
 		 *
 		 * @return {WPDependencyBlockCorrection | undefined} Correction, if applicable.
 		 */
-		function getDependencyBlockCorrection(node, locality) {
-			const value = getCommentValue(locality);
+		function getDependencyBlockCorrection( node, locality ) {
+			const value = getCommentValue( locality );
 
-			for (const comment of comments) {
-				if (!isBefore(comment, node)) {
+			for ( const comment of comments ) {
+				if ( ! isBefore( comment, node ) ) {
 					// Exhausted options.
 					break;
 				}
 
-				if (!isLocalityDependencyBlock(comment, locality)) {
+				if ( ! isLocalityDependencyBlock( comment, locality ) ) {
 					// Not usable (either not an block comment, or not one
 					// matching a tolerable pattern).
 					continue;
 				}
 
-				if (comment.value === value) {
+				if ( comment.value === value ) {
 					// No change needed. (OK)
 					return;
 				}
@@ -159,7 +156,7 @@ module.exports = {
 			/**
 			 * @param {import('estree').Program} node Program node.
 			 */
-			Program(node) {
+			Program( node ) {
 				/**
 				 * The set of package localities which have been reported for
 				 * the current program. Each locality is reported at most one
@@ -181,25 +178,24 @@ module.exports = {
 				// Since we only care to enforce imports which occur at the
 				// top-level scope, match on Program and test its children,
 				// rather than matching the import nodes directly.
-				node.body.forEach((child) => {
+				node.body.forEach( child => {
 					/** @type {string} */
 					let source;
-					switch (child.type) {
+					switch ( child.type ) {
 						case 'ImportDeclaration':
-							source = /** @type {string} */ (child.source.value);
-							candidates.push([child, source]);
+							source = /** @type {string} */ ( child.source.value );
+							candidates.push( [ child, source ] );
 							break;
 
 						case 'VariableDeclaration':
-							child.declarations.forEach((declaration) => {
+							child.declarations.forEach( declaration => {
 								const { init } = declaration;
 								if (
-									!init ||
+									! init ||
 									init.type !== 'CallExpression' ||
-									/** @type {import('estree').CallExpression} */ (init).callee
-										.type !== 'Identifier' ||
-									/** @type {import('estree').Identifier} */ (init.callee)
-										.name !== 'require'
+									/** @type {import('estree').CallExpression} */ ( init ).callee.type !==
+										'Identifier' ||
+									/** @type {import('estree').Identifier} */ ( init.callee ).name !== 'require'
 								) {
 									return;
 								}
@@ -207,45 +203,45 @@ module.exports = {
 								const { arguments: args } = init;
 								if (
 									args.length === 1 &&
-									args[0].type === 'Literal' &&
-									typeof args[0].value === 'string'
+									args[ 0 ].type === 'Literal' &&
+									typeof args[ 0 ].value === 'string'
 								) {
-									source = args[0].value;
-									candidates.push([child, source]);
+									source = args[ 0 ].value;
+									candidates.push( [ child, source ] );
 								}
-							});
+							} );
 					}
-				});
+				} );
 
-				for (const [child, source] of candidates) {
-					const locality = getPackageLocality(source);
-					if (verified.has(locality)) {
+				for ( const [ child, source ] of candidates ) {
+					const locality = getPackageLocality( source );
+					if ( verified.has( locality ) ) {
 						continue;
 					}
 
 					// Avoid verifying any other imports for the locality,
 					// regardless whether a correction must be made.
-					verified.add(locality);
+					verified.add( locality );
 
 					// Determine whether a correction must be made.
-					const correction = getDependencyBlockCorrection(child, locality);
-					if (!correction) {
+					const correction = getDependencyBlockCorrection( child, locality );
+					if ( ! correction ) {
 						continue;
 					}
 
-					context.report({
+					context.report( {
 						node: child,
-						message: `Expected preceding "${locality} dependencies" comment block`,
-						fix(fixer) {
+						message: `Expected preceding "${ locality } dependencies" comment block`,
+						fix( fixer ) {
 							const { comment, value } = correction;
-							const text = `/*${value}*/`;
-							if (comment && comment.range) {
-								return fixer.replaceTextRange(comment.range, text);
+							const text = `/*${ value }*/`;
+							if ( comment && comment.range ) {
+								return fixer.replaceTextRange( comment.range, text );
 							}
 
-							return fixer.insertTextBefore(child, text + '\n');
+							return fixer.insertTextBefore( child, text + '\n' );
 						},
-					});
+					} );
 				}
 			},
 		};

package/rules/index.js

@@ -2,7 +2,7 @@
  * Custom ESLint rules
  */
 module.exports = {
-	'dependency-group': require('./dependency-group'),
-	'no-async-foreach': require('./no-async-foreach'),
-	'no-unguarded-get-range-at': require('./no-unguarded-get-range-at'),
+	'dependency-group': require( './dependency-group' ),
+	'no-async-foreach': require( './no-async-foreach' ),
+	'no-unguarded-get-range-at': require( './no-unguarded-get-range-at' ),
 };

package/rules/no-async-foreach.js

@@ -8,26 +8,20 @@
  */
 
 module.exports = {
-	create(context) {
+	create( context ) {
 		return {
-			ExpressionStatement(node) {
+			ExpressionStatement( node ) {
 				const { callee } = node.expression;
-				if (!callee || !callee.property || !callee.property.name) {
+				if ( ! callee || ! callee.property || ! callee.property.name ) {
 					return;
 				}
-				if (callee.property.name === 'forEach') {
-					const functionArguments = node.expression.arguments.find((exp) => {
-						return (
-							exp.type === 'ArrowFunctionExpression' ||
-							exp.type === 'FunctionExpression'
-						);
-					});
-					if (functionArguments) {
-						if (functionArguments.async) {
-							context.report(
-								node,
-								'Avoid passing an async function to Array.prototype.forEach'
-							);
+				if ( callee.property.name === 'forEach' ) {
+					const functionArguments = node.expression.arguments.find( exp => {
+						return exp.type === 'ArrowFunctionExpression' || exp.type === 'FunctionExpression';
+					} );
+					if ( functionArguments ) {
+						if ( functionArguments.async ) {
+							context.report( node, 'Avoid passing an async function to Array.prototype.forEach' );
 						}
 					}
 				}

package/rules/no-unguarded-get-range-at.js

@@ -8,15 +8,15 @@ module.exports = {
 		type: 'problem',
 		schema: [],
 	},
-	create(context) {
+	create( context ) {
 		return {
 			'CallExpression[callee.object.callee.property.name="getSelection"][callee.property.name="getRangeAt"]'(
 				node
 			) {
-				context.report({
+				context.report( {
 					node,
 					message: 'Avoid unguarded getRangeAt',
-				});
+				} );
 			},
 		};
 	},

package/utils/debug-log.js

@@ -1,7 +1,7 @@
-module.exports = function debugLog(message) {
-	if (process.env.DEBUG) {
+module.exports = function debugLog( message ) {
+	if ( process.env.DEBUG ) {
 		// Debugging output.
 		// eslint-disable-next-line no-console
-		console.log(message);
+		console.log( message );
 	}
 };

package/utils/is-package-installed.js

@@ -1,14 +1,14 @@
-const debugLog = require('./debug-log');
-const findPackageJson = require('find-package-json');
+const debugLog = require( './debug-log' );
+const findPackageJson = require( 'find-package-json' );
 
-const packages = [...findPackageJson(__dirname)];
+const packages = [ ...findPackageJson( __dirname ) ];
 const parent = packages.pop() || {};
 
-debugLog(`Found package.json: ${parent.__path || 'none'}`);
+debugLog( `Found package.json: ${ parent.__path || 'none' }` );
 
-module.exports = function isPackageInstalled(packageName) {
-	const isDevDependency = !!parent.devDependencies?.[`${packageName}`];
-	const isProdDependency = !!parent.dependencies?.[`${packageName}`];
+module.exports = function isPackageInstalled( packageName ) {
+	const isDevDependency = !! parent.devDependencies?.[ `${ packageName }` ];
+	const isProdDependency = !! parent.dependencies?.[ `${ packageName }` ];
 
 	return isDevDependency || isProdDependency;
 };