@automattic/eslint-plugin-wpvip 0.13.0 → 1.0.0

package/configs/react.js

@@ -3,67 +3,69 @@
  * https://github.com/WordPress/gutenberg/blob/%40wordpress/eslint-plugin%4014.1.0/packages/eslint-plugin/configs/react.js
  */
 
-module.exports = {
-	extends: [
-		'plugin:react/recommended',
-		'plugin:react-hooks/recommended',
-		'plugin:jsx-a11y/recommended',
-	],
-
-	parserOptions: {
-		ecmaFeatures: {
-			jsx: true,
+const JsxA11yPlugin = require( 'eslint-plugin-jsx-a11y' );
+const ReactPlugin = require( 'eslint-plugin-react' );
+const ReactHooksPlugin = require( 'eslint-plugin-react-hooks' );
+
+/** @type import('eslint').Linter.Config[] */
+module.exports = [
+	ReactPlugin.configs.flat.recommended,
+	ReactHooksPlugin.configs.recommended,
+	JsxA11yPlugin.flatConfigs.recommended,
+	{
+		parserOptions: {
+			ecmaFeatures: {
+				jsx: true,
+			},
 		},
-	},
 
-	settings: {
-		react: {
-			version: 'detect',
+		settings: {
+			react: {
+				version: 'detect',
+			},
 		},
-	},
 
-	plugins: [ '@automattic/wpvip', 'jsx-a11y', 'react', 'react-hooks' ],
+		rules: {
+			'jsx-a11y/label-has-associated-control': [
+				'error',
+				{
+					assert: 'htmlFor',
+				},
+			],
 
-	rules: {
-		'jsx-a11y/label-has-associated-control': [
-			'error',
-			{
-				assert: 'htmlFor',
-			},
-		],
-
-		'jsx-a11y/media-has-caption': 'off',
+			'jsx-a11y/media-has-caption': 'off',
 
-		'jsx-a11y/no-noninteractive-tabindex': 'off',
+			'jsx-a11y/no-noninteractive-tabindex': 'off',
 
-		'jsx-a11y/role-has-required-aria-props': 'off',
+			'jsx-a11y/role-has-required-aria-props': 'off',
 
-		'jsx-quotes': 'error',
+			'jsx-quotes': 'error',
 
-		'react/display-name': 'off',
+			'react/display-name': 'off',
 
-		'react/jsx-curly-spacing': [
-			'error',
-			{
-				when: 'always',
-				children: true,
-			},
-		],
+			'react/jsx-curly-spacing': [
+				'error',
+				{
+					when: 'always',
+					children: true,
+				},
+			],
 
-		'react/jsx-equals-spacing': 'error',
+			'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',
+			'react/jsx-key': 'error',
 
-		'react/jsx-tag-spacing': 'error',
+			'react/jsx-tag-spacing': 'error',
 
-		'react/no-children-prop': 'off',
+			'react/no-children-prop': 'off',
 
-		'react/prop-types': 'off',
+			'react/prop-types': 'off',
 
-		'react/react-in-jsx-scope': 'off',
+			'react/react-in-jsx-scope': 'off',
+		},
 	},
-};
+];

package/configs/recommended.js

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

package/configs/testing.js

@@ -1,3 +1,6 @@
+const JestPlugin = require( 'eslint-plugin-jest' );
+const globals = require( 'globals' );
+
 const isPackageInstalled = require( '../utils/is-package-installed' );
 
 /**
@@ -6,28 +9,26 @@ const isPackageInstalled = require( '../utils/is-package-installed' );
  * - https://github.com/WordPress/gutenberg/blob/%40wordpress/eslint-plugin%4014.1.0/packages/eslint-plugin/configs/test-e2e.js
  */
 
-const config = {
-	extends: [ 'plugin:jest/recommended' ],
-
-	env: {
-		'jest/globals': true,
+/** @type import('eslint').Linter.Config[] */
+const config = [
+	JestPlugin.configs[ 'flat/recommended' ],
+	{
+		languageOptions: {
+			globals: {
+				...globals.jest,
+			},
+		},
 	},
-
-	plugins: [ 'jest' ],
-};
+];
 
 if ( isPackageInstalled( 'typescript' ) ) {
-	// Add an override for TypeScript's overzealous unbound-method rule that allows
-	// Jest mocks to be inspected without being bound to a variable.
-	config.overrides = [
-		{
-			files: [ '__tests__/**/*.ts', '**/*.test.ts', '**/*.spec.ts' ],
-			rules: {
-				'@typescript-eslint/unbound-method': 'off',
-				'jest/unbound-method': 'error',
-			},
+	config.push( {
+		files: [ '__tests__/**/*.ts', '**/*.test.ts', '**/*.spec.ts' ],
+		rules: {
+			'@typescript-eslint/unbound-method': 'off',
+			'jest/unbound-method': 'error',
 		},
-	];
+	} );
 }
 
 module.exports = config;

package/configs/typescript.js

@@ -3,84 +3,103 @@
  * https://github.com/WordPress/gutenberg/blob/%40wordpress/eslint-plugin%4014.1.0/packages/eslint-plugin/configs/recommended.js
  */
 
-module.exports = {
-	ignorePatterns: [ '**/*.d.ts', '**/*.d.cts', '**/*.d.mts' ],
+const TsEsLintParser = require( '@typescript-eslint/parser' );
+const JsDoc = require( 'eslint-plugin-jsdoc' );
+const tseslint = require( 'typescript-eslint' );
 
-	overrides: [
-		{
-			extends: [
-				'plugin:@typescript-eslint/eslint-recommended',
-				'plugin:@typescript-eslint/recommended-requiring-type-checking',
-				'plugin:@typescript-eslint/strict',
-			],
+const files = [ '**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts' ];
 
-			files: [ '**/*.ts', '**/*.tsx', '**/*.cts', '**/*.mts' ],
+/**
+ * @param {import('eslint').Linter.Config} config
+ * @returns {import('eslint').Linter.Config}
+ */
+const addFiles = config => ( config.files ? config : { ...config, files } );
 
-			parser: '@typescript-eslint/parser',
+const tsEslintTypeChecked = tseslint.configs.recommendedTypeChecked.map( addFiles );
+const tsEslintStrict = tseslint.configs.strict.map( addFiles ); // Already includes `recommended`
 
+/** @type import('eslint').Linter.Config[] */
+module.exports = [
+	...tsEslintTypeChecked,
+	...tsEslintStrict,
+	{
+		ignores: [ '**/*.d.ts', '**/*.d.cts', '**/*.d.mts' ],
+	},
+	{
+		files,
+		languageOptions: {
+			parser: TsEsLintParser,
 			parserOptions: {
-				project: './tsconfig.json',
+				projectService: true,
 			},
+		},
+		plugins: {
+			'@typescript-eslint': tseslint.plugin,
+			'@automattic/wpvip': require( '../plugin' ),
+			jsdoc: JsDoc,
+		},
+		rules: {
+			// Ensures NestJS route prefixes are correctly formatted.
+			'@automattic/wpvip/nestjs-route-prefix': 'error',
 
-			rules: {
-				// Ensures NestJS route prefixes are correctly formatted.
-				'@automattic/wpvip/nestjs-route-prefix': 'error',
-
-				// Require explicity visibility for class methods and properties to avoid
-				// implicit public access. Allow constructors to be implicitly public.
-				'@typescript-eslint/explicit-member-accessibility': [
-					'error',
-					{
-						overrides: {
-							constructors: 'off',
-						},
+			// Require explicit visibility for class methods and properties to avoid
+			// implicit public access. Allow constructors to be implicitly public.
+			'@typescript-eslint/explicit-member-accessibility': [
+				'error',
+				{
+					overrides: {
+						constructors: 'off',
 					},
-				],
+				},
+			],
 
-				// TypeScript `any` type must not be used. This is a warning in the base
-				// config, and is elevated to an error here.
-				'@typescript-eslint/no-explicit-any': 'error',
+			// TypeScript `any` type must not be used. This is a warning in the base
+			// config, and is elevated to an error here.
+			'@typescript-eslint/no-explicit-any': 'error',
 
-				// Provide escape hatches around destructuring and arguments.
-				'@typescript-eslint/no-unused-vars': [
-					'error',
-					{
-						argsIgnorePattern: '^_',
-						destructuredArrayIgnorePattern: '^_',
-						ignoreRestSiblings: true,
-					},
-				],
+			// Provide escape hatches around destructuring and arguments.
+			'no-unused-vars': 'off',
+			'@typescript-eslint/no-unused-vars': [
+				'error',
+				{
+					argsIgnorePattern: '^_',
+					destructuredArrayIgnorePattern: '^_',
+					ignoreRestSiblings: true,
+				},
+			],
 
-				// Disable some rules that TypeScript handles and are also a Performance
-				// issue. See:
-				// https://github.com/typescript-eslint/typescript-eslint/blob/main/docs/linting/troubleshooting/Performance.md#eslint-plugin-import
-				'import/default': 'off',
-				'import/named': 'off',
+			// Disable some rules that TypeScript handles and are also a Performance
+			// issue. See:
+			// https://github.com/typescript-eslint/typescript-eslint/blob/main/docs/linting/troubleshooting/Performance.md#eslint-plugin-import
+			'import/default': 'off',
+			'import/named': 'off',
 
-				// Don't require redundant JSDoc types in TypeScript files.
-				'jsdoc/require-param-type': 'off',
-				'jsdoc/require-returns-type': 'off',
+			// Don't require redundant JSDoc types in TypeScript files.
+			'jsdoc/require-param-type': 'off',
+			'jsdoc/require-returns-type': 'off',
 
-				// Use TypeScript-specific rules.
-				'no-duplicate-imports': 'off',
-				'no-shadow': 'off',
-				'@typescript-eslint/no-shadow': 'error',
-				'import/no-duplicates': 'error',
+			// Use TypeScript-specific rules.
+			'no-duplicate-imports': 'off',
+			'no-shadow': 'off',
+			'@typescript-eslint/no-shadow': 'error',
+			'import/no-duplicates': 'error',
 
-				'dot-notation': 'off',
-				'@typescript-eslint/dot-notation': [ 'error', { allowKeywords: true } ],
+			'dot-notation': 'off',
+			'@typescript-eslint/dot-notation': [ 'error', { allowKeywords: true } ],
 
-				// Empty classes are allowed if they are accompanied by a decorator.
-				// This is common in frameworks such as Angular / nest.js.
-				'@typescript-eslint/no-extraneous-class': [
-					'warn',
-					{
-						allowWithDecorator: true,
-					},
-				],
-			},
-		},
-	],
+			// Empty classes are allowed if they are accompanied by a decorator.
+			// This is common in frameworks such as Angular / nest.js.
+			'@typescript-eslint/no-extraneous-class': [
+				'warn',
+				{
+					allowWithDecorator: true,
+				},
+			],
+
+			'class-methods-use-this': 'off',
 
-	plugins: [ '@typescript-eslint', 'jsdoc' ],
-};
+			'default-param-last': 'off',
+			'@typescript-eslint/default-param-last': 'error',
+		},
+	},
+];

package/configs/weak-javascript.js

@@ -6,64 +6,46 @@
  * They do not provide good protection or standardization, but can useful on a
  * temporary basis.
  */
-module.exports = {
-	overrides: [
-		{
-			// Don't apply weak rules to TypeScript files.
-			files: [ '**/*.js', '**/*.jsx' ],
 
-			/**
-			 * Downgrade rules from the base preset to "warn". Do not disable rules (set
-			 * to "off"). If a rule is already set to a warning, do not disable it.
-			 */
-			rules: {
-				complexity: 'warn',
-
-				eqeqeq: 'warn',
-
-				'object-shorthand': 'warn',
-
-				'no-async-promise-executor': 'warn',
-
-				'no-await-in-loop': 'warn',
-
-				'no-case-declarations': 'warn',
-
-				'no-dupe-else-if': 'warn',
-
-				'no-else-return': 'warn',
-
-				'no-eq-null': 'warn',
-
-				'no-lonely-if': 'warn',
-
-				'no-mixed-operators': 'warn',
-
-				'no-prototype-builtins': 'warn',
-
-				'no-shadow': 'warn',
-
-				'no-unused-vars': 'warn',
-
-				'no-useless-escape': 'warn',
-
-				'no-var': 'warn',
-
-				'one-var': 'warn',
-
-				radix: 'warn',
-
-				'promise/no-new-statics': 'warn',
-				'promise/no-return-in-finally': 'warn',
-				'promise/no-return-wrap': 'warn',
-				'promise/param-names': 'warn',
-				'promise/valid-params': 'warn',
-
-				// This rule has been disabled because it is extremely slow:
-				// https://github.com/Automattic/vip-cli/pull/1534
-				//
-				// 'promise/no-multiple-resolved': 'warn',
-			},
+/** @type import('eslint').Linter.Config[] */
+module.exports = [
+	{
+		// Don't apply weak rules to TypeScript files.
+		files: [ '**/*.js', '**/*.jsx' ],
+
+		/**
+		 * Downgrade rules from the base preset to "warn". Do not disable rules (set
+		 * to "off"). If a rule is already set to a warning, do not disable it.
+		 */
+		rules: {
+			complexity: 'warn',
+			eqeqeq: 'warn',
+			'object-shorthand': 'warn',
+			'no-async-promise-executor': 'warn',
+			'no-await-in-loop': 'warn',
+			'no-case-declarations': 'warn',
+			'no-dupe-else-if': 'warn',
+			'no-else-return': 'warn',
+			'no-eq-null': 'warn',
+			'no-lonely-if': 'warn',
+			'no-mixed-operators': 'warn',
+			'no-prototype-builtins': 'warn',
+			'no-shadow': 'warn',
+			'no-unused-vars': 'warn',
+			'no-useless-escape': 'warn',
+			'no-var': 'warn',
+			'one-var': 'warn',
+			radix: 'warn',
+			'promise/no-new-statics': 'warn',
+			'promise/no-return-in-finally': 'warn',
+			'promise/no-return-wrap': 'warn',
+			'promise/param-names': 'warn',
+			'promise/valid-params': 'warn',
+
+			// This rule has been disabled because it is extremely slow:
+			// https://github.com/Automattic/vip-cli/pull/1534
+			//
+			// 'promise/no-multiple-resolved': 'warn',
 		},
-	],
-};
+	},
+];

package/configs/weak-testing.js

@@ -6,18 +6,19 @@
  * They do not provide good protection or standardization, but can useful on a
  * temporary basis.
  */
-module.exports = {
-	/**
-	 * Downgrade rules from the testing preset to "warn". Do not disable rules
-	 * (set to "off"). If a rule is already set to a warning, do not disable it.
-	 */
-	rules: {
-		'jest/no-alias-methods': 'warn',
 
-		'jest/no-done-callback': 'warn',
-
-		'jest/no-conditional-expect': 'warn',
-
-		'jest/no-standalone-expect': 'warn',
+/** @type import('eslint').Linter.Config[] */
+module.exports = [
+	{
+		/**
+		 * Downgrade rules from the testing preset to "warn". Do not disable rules
+		 * (set to "off"). If a rule is already set to a warning, do not disable it.
+		 */
+		rules: {
+			'jest/no-alias-methods': 'warn',
+			'jest/no-done-callback': 'warn',
+			'jest/no-conditional-expect': 'warn',
+			'jest/no-standalone-expect': 'warn',
+		},
 	},
-};
+];

package/configs/weak-typescript.js

@@ -2,44 +2,33 @@
  * "Weak" TypeScript rules
  * ==========================
  * These rules are intended to extend the base `typescript` rules and will help
- * you migrate an existing project to TypeScript.
+ * you migrate an existing project to TypeScript. They are primarily focused on
+ * allowing relaxed or omitted types.
  */
-module.exports = {
-	overrides: [
-		{
-			files: [ '**/*.ts', '**/*.tsx', '**/*.cts', '**/*.mts' ],
 
-			/**
-			 * Downgrade rules from the base preset to "warn". Do not disable rules (set
-			 * to "off"). If a rule is already set to a warning, do not disable it.
-			 */
-			rules: {
-				'@typescript-eslint/no-explicit-any': 'warn',
-
-				'@typescript-eslint/no-floating-promises': 'warn',
-
-				'@typescript-eslint/no-misused-promises': 'warn',
-
-				'@typescript-eslint/no-unsafe-argument': 'warn',
-
-				'@typescript-eslint/no-unsafe-assignment': 'warn',
-
-				'@typescript-eslint/no-unsafe-call': 'warn',
-
-				'@typescript-eslint/no-unsafe-member-access': 'warn',
-
-				'@typescript-eslint/no-unsafe-return': 'warn',
-
-				'@typescript-eslint/require-await': 'warn',
-
-				'@typescript-eslint/restrict-plus-operands': 'warn',
-
-				'@typescript-eslint/restrict-template-expressions': 'warn',
-
-				'@typescript-eslint/unbound-method': 'warn',
-
-				'import/no-duplicates': 'warn',
-			},
+/** @type import('eslint').Linter.Config[] */
+module.exports = [
+	{
+		files: [ '**/*.ts', '**/*.tsx', '**/*.cts', '**/*.mts' ],
+
+		/**
+		 * Downgrade rules from the base preset to "warn". Do not disable rules (set
+		 * to "off"). If a rule is already set to a warning, do not disable it.
+		 */
+		rules: {
+			'@typescript-eslint/no-explicit-any': 'warn',
+			'@typescript-eslint/no-floating-promises': 'warn',
+			'@typescript-eslint/no-misused-promises': 'warn',
+			'@typescript-eslint/no-unsafe-argument': 'warn',
+			'@typescript-eslint/no-unsafe-assignment': 'warn',
+			'@typescript-eslint/no-unsafe-call': 'warn',
+			'@typescript-eslint/no-unsafe-member-access': 'warn',
+			'@typescript-eslint/no-unsafe-return': 'warn',
+			'@typescript-eslint/require-await': 'warn',
+			'@typescript-eslint/restrict-plus-operands': 'warn',
+			'@typescript-eslint/restrict-template-expressions': 'warn',
+			'@typescript-eslint/unbound-method': 'warn',
+			'import/no-duplicates': 'warn',
 		},
-	],
-};
+	},
+];

package/eslint.config.js

@@ -0,0 +1,13 @@
+/**
+ * Do not copy this eslint.config.js for your project. See the README for instructions.
+ */
+
+const AutomatticPlugin = require( '.' );
+
+/** @type import('eslint').Linter.Config[] */
+module.exports = [
+	{
+		ignores: [ '__fixtures__/**/*' ],
+	},
+	...AutomatticPlugin.configs.recommended,
+];

package/index.js

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