@automattic/eslint-plugin-wpvip 0.13.1 → 1.1.0

package/configs/javascript.js

@@ -6,257 +6,275 @@
  * - https://github.com/WordPress/gutenberg/blob/%40wordpress/eslint-plugin%4014.1.0/packages/eslint-plugin/configs/recommended-with-formatting.js
  */
 
-module.exports = {
-	env: {
-		es2022: true, // 100% covered by Node.js v16
-		node: true,
-	},
-
-	extends: [ 'plugin:json/recommended', 'plugin:security/recommended' ],
-
-	parser: '@babel/eslint-parser',
-
-	parserOptions: {
-		requireConfigFile: false,
-		sourceType: 'module',
+const babelParser = require( '@babel/eslint-parser' );
+const ImportPlugin = require( 'eslint-plugin-import' );
+const JsonPlugin = require( 'eslint-plugin-json' );
+const PromisePlugin = require( 'eslint-plugin-promise' );
+const SecurityPluginConfigs = require( 'eslint-plugin-security' );
+const UnusedImportsPlugin = require( 'eslint-plugin-unused-imports' );
+const globals = require( 'globals' );
+
+/** @type import('eslint').Linter.Config[] */
+module.exports = [
+	JsonPlugin.configs.recommended,
+	{
+		files: [ '**/tsconfig*.json' ],
+		rules: {
+			'json/*': [ 'error', { allowComments: true } ],
+		},
 	},
-
-	/**
-	 * Note: We must explicitly add this plugin to use our custom rules.
-	 */
-	plugins: [ '@automattic/wpvip', 'import', 'promise', 'unused-imports' ],
-
-	/**
-	 * Please include a short description of the rule. For rules that downgrade or
-	 * disable errors, include a brief justification or reasoning.
-	 */
-	rules: {
-		// BEGIN eslint:recommended, enumerated here for visibility:
-		// https://github.com/eslint/eslint/blob/main/packages/js/src/configs/eslint-recommended.js
-		'constructor-super': 'error',
-		'for-direction': 'error',
-		'getter-return': 'error',
-		'no-async-promise-executor': 'error',
-		'no-case-declarations': 'error',
-		'no-class-assign': 'error',
-		'no-compare-neg-zero': 'error',
-		// 'no-cond-assign': 'error', // extended below
-		'no-const-assign': 'error',
-		'no-constant-binary-expression': 'error',
-		'no-constant-condition': 'error',
-		'no-control-regex': 'error',
-		'no-debugger': 'error',
-		'no-delete-var': 'error',
-		'no-dupe-args': 'error',
-		'no-dupe-class-members': 'error',
-		'no-dupe-else-if': 'error',
-		'no-dupe-keys': 'error',
-		'no-duplicate-case': 'error',
-		// 'no-empty': 'error', // extended below
-		'no-empty-character-class': 'error',
-		'no-empty-pattern': 'error',
-		'no-ex-assign': 'error',
-		'no-extra-boolean-cast': 'error',
-		'no-extra-semi': 'error',
-		'no-fallthrough': 'error',
-		'no-func-assign': 'error',
-		'no-global-assign': 'error',
-		'no-import-assign': 'error',
-		'no-inner-declarations': 'error',
-		'no-invalid-regexp': 'error',
-		'no-irregular-whitespace': 'error',
-		'no-loss-of-precision': 'error',
-		'no-misleading-character-class': 'error',
-		'no-mixed-spaces-and-tabs': 'error',
-		'no-new-symbol': 'error',
-		'no-nonoctal-decimal-escape': 'error',
-		'no-obj-calls': 'error',
-		'no-octal': 'error',
-		'no-prototype-builtins': 'error',
-		'no-redeclare': 'error',
-		'no-regex-spaces': 'error',
-		'no-self-assign': 'error',
-		'no-setter-return': 'error',
-		'no-shadow-restricted-names': 'error',
-		'no-sparse-arrays': 'error',
-		'no-this-before-super': 'error',
-		'no-undef': 'error',
-		'no-unexpected-multiline': 'error',
-		'no-unreachable': 'error',
-		'no-unsafe-finally': 'error',
-		'no-unsafe-negation': 'error',
-		'no-unsafe-optional-chaining': 'error',
-		'no-unused-labels': 'error',
-		// 'no-unused-vars': 'error', // extended below
-		'no-useless-backreference': 'error',
-		'no-useless-catch': 'error',
-		'no-useless-escape': 'error',
-		'no-with': 'error',
-		'require-yield': 'error',
-		'use-isnan': 'error',
-		// 'valid-typeof': 'error', // extended below
-		// END eslint:recommended
-
-		// Async/await must not be used in a `.forEach` method, because the result
-		// will not be awaited in the outer scope.
-		'@automattic/wpvip/no-async-foreach': 'error',
-
-		// Unguarded getRangeAt calls can throw errors in some browsers.
-		'@automattic/wpvip/no-unguarded-get-range-at': 'error',
-
-		'array-callback-return': 'error',
-
-		// Maximum cyclomatic complexity must not be above 20.
-		complexity: 'error',
-
-		eqeqeq: 'error',
-
-		// Identifiers should be between 2 and 40 characters in length in order to
-		// provide a concise semantic meaning.
-		'id-length': [
-			'warn',
-			{
-				min: 2,
-				max: 40,
+	SecurityPluginConfigs.configs.recommended,
+	{
+		languageOptions: {
+			ecmaVersion: 2022,
+			globals: {
+				...globals.node,
+				...globals.nodeBuiltin,
 			},
-		],
+			parser: babelParser,
+			parserOptions: {
+				requireConfigFile: false,
+				sourceType: 'module',
+				ecmaVersion: 2022,
+			},
+		},
+		plugins: {
+			'@automattic/wpvip': require( '../plugin' ),
+			import: ImportPlugin,
+			promise: PromisePlugin,
+			'unused-imports': UnusedImportsPlugin,
+		},
+		/**
+		 * Please include a short description of the rule. For rules that downgrade or
+		 * disable errors, include a brief justification or reasoning.
+		 */
+		rules: {
+			// BEGIN eslint:recommended, enumerated here for visibility:
+			// https://github.com/eslint/eslint/blob/main/packages/js/src/configs/eslint-recommended.js
+			'constructor-super': 'error',
+			'for-direction': 'error',
+			'getter-return': 'error',
+			'no-async-promise-executor': 'error',
+			'no-case-declarations': 'error',
+			'no-class-assign': 'error',
+			'no-compare-neg-zero': 'error',
+			// 'no-cond-assign': 'error', // extended below
+			'no-const-assign': 'error',
+			'no-constant-binary-expression': 'error',
+			'no-constant-condition': 'error',
+			'no-control-regex': 'error',
+			'no-debugger': 'error',
+			'no-delete-var': 'error',
+			'no-dupe-args': 'error',
+			'no-dupe-class-members': 'error',
+			'no-dupe-else-if': 'error',
+			'no-dupe-keys': 'error',
+			'no-duplicate-case': 'error',
+			// 'no-empty': 'error', // extended below
+			'no-empty-character-class': 'error',
+			'no-empty-pattern': 'error',
+			'no-ex-assign': 'error',
+			'no-extra-boolean-cast': 'error',
+			'no-extra-semi': 'error',
+			'no-fallthrough': 'error',
+			'no-func-assign': 'error',
+			'no-global-assign': 'error',
+			'no-import-assign': 'error',
+			'no-inner-declarations': 'error',
+			'no-invalid-regexp': 'error',
+			'no-irregular-whitespace': 'error',
+			'no-loss-of-precision': 'error',
+			'no-misleading-character-class': 'error',
+			'no-mixed-spaces-and-tabs': 'error',
+			'no-new-symbol': 'error',
+			'no-nonoctal-decimal-escape': 'error',
+			'no-obj-calls': 'error',
+			'no-octal': 'error',
+			'no-prototype-builtins': 'error',
+			'no-redeclare': 'error',
+			'no-regex-spaces': 'error',
+			'no-self-assign': 'error',
+			'no-setter-return': 'error',
+			'no-shadow-restricted-names': 'error',
+			'no-sparse-arrays': 'error',
+			'no-this-before-super': 'error',
+			'no-undef': 'error',
+			'no-unexpected-multiline': 'error',
+			'no-unreachable': 'error',
+			'no-unsafe-finally': 'error',
+			'no-unsafe-negation': 'error',
+			'no-unsafe-optional-chaining': 'error',
+			'no-unused-labels': 'error',
+			// 'no-unused-vars': 'error', // extended below
+			'no-useless-backreference': 'error',
+			'no-useless-catch': 'error',
+			'no-useless-escape': 'error',
+			'no-with': 'error',
+			'require-yield': 'error',
+			'use-isnan': 'error',
+			// 'valid-typeof': 'error', // extended below
+			// END eslint:recommended
+
+			// Async/await must not be used in a `.forEach` method, because the result
+			// will not be awaited in the outer scope.
+			'@automattic/wpvip/no-async-foreach': 'error',
+
+			// Unguarded getRangeAt calls can throw errors in some browsers.
+			'@automattic/wpvip/no-unguarded-get-range-at': 'error',
+
+			'array-callback-return': 'error',
+
+			// Maximum cyclomatic complexity must not be above 20.
+			complexity: 'error',
+
+			eqeqeq: 'error',
+
+			// Identifiers should be between 2 and 40 characters in length in order to
+			// provide a concise semantic meaning.
+			'id-length': [
+				'warn',
+				{
+					min: 2,
+					max: 40,
+				},
+			],
 
-		'import/default': 'warn',
+			'import/default': 'warn',
 
-		'import/named': 'warn',
+			'import/named': 'warn',
 
-		'import/no-extraneous-dependencies': [
-			'error',
-			{
-				peerDependencies: true,
-			},
-		],
-
-		'import/no-unresolved': 'error',
-		'unused-imports/no-unused-imports': 'warn',
-
-		// Enforce external / internal import groups and alphabetical ordering.
-		'import/order': [
-			'error',
-			{
-				'newlines-between': 'always',
-				alphabetize: {
-					order: 'asc',
+			'import/no-extraneous-dependencies': [
+				'error',
+				{
+					peerDependencies: true,
 				},
-				groups: [
-					[ 'builtin', 'external' ],
-					[ 'index', 'internal', 'object', 'parent', 'sibling' ],
-					[ 'type' ],
-				],
-			},
-		],
+			],
+
+			'import/no-unresolved': 'error',
+			'unused-imports/no-unused-imports': 'warn',
+
+			// Enforce external / internal import groups and alphabetical ordering.
+			'import/order': [
+				'error',
+				{
+					'newlines-between': 'always',
+					alphabetize: {
+						order: 'asc',
+					},
+					groups: [
+						[ 'builtin', 'external' ],
+						[ 'index', 'internal', 'object', 'parent', 'sibling' ],
+						[ 'type' ],
+					],
+				},
+			],
 
-		// Enforce Unix linebreaks. Included here and not in "formatting" since it
-		// is not controversial and helps with interchange.
-		'linebreak-style': [ 'error', 'unix' ],
+			// Enforce Unix linebreaks. Included here and not in "formatting" since it
+			// is not controversial and helps with interchange.
+			'linebreak-style': [ 'error', 'unix' ],
 
-		'no-alert': 'error',
+			'no-alert': 'error',
 
-		// Async/await must not be used in a loop, because it leads to sequential
-		// execution, when parallel execution is almost always preferred.
-		'no-await-in-loop': 'error',
+			// Async/await must not be used in a loop, because it leads to sequential
+			// execution, when parallel execution is almost always preferred.
+			'no-await-in-loop': 'error',
 
-		'no-bitwise': 'error',
+			'no-bitwise': 'error',
 
-		'no-caller': 'error',
+			'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).
-		'no-console': 'warn',
+			// `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).
+			'no-console': 'warn',
 
-		// A single `import` statement should be used when importing multiple things
-		// from a module.
-		'no-duplicate-imports': 'error',
+			// A single `import` statement should be used when importing multiple things
+			// from a module.
+			'no-duplicate-imports': 'error',
 
-		'no-else-return': 'error',
+			'no-else-return': 'error',
 
-		'no-empty': [ 'error', { allowEmptyCatch: true } ],
+			'no-empty': [ 'error', { allowEmptyCatch: true } ],
 
-		'no-eq-null': 'error',
+			'no-eq-null': 'error',
 
-		'no-eval': 'error',
+			'no-eval': 'error',
 
-		'no-lonely-if': 'error',
+			'no-lonely-if': 'error',
 
-		'no-implicit-coercion': 'error',
+			'no-implicit-coercion': 'error',
 
-		'no-mixed-operators': 'error',
+			'no-mixed-operators': 'error',
 
-		'no-nested-ternary': 'error',
+			'no-nested-ternary': 'error',
 
-		'no-shadow': 'error',
+			'no-shadow': 'error',
 
-		'no-undef-init': 'error',
+			'no-undef-init': 'error',
 
-		'no-unused-expressions': 'error',
+			'no-unused-expressions': 'error',
 
-		'no-unused-vars': [
-			'error',
-			{
-				argsIgnorePattern: '^_',
-				destructuredArrayIgnorePattern: '^_',
-				ignoreRestSiblings: true,
-			},
-		],
-
-		'no-useless-computed-key': 'error',
+			'no-unused-vars': [
+				'error',
+				{
+					argsIgnorePattern: '^_',
+					destructuredArrayIgnorePattern: '^_',
+					ignoreRestSiblings: true,
+				},
+			],
 
-		'no-useless-constructor': 'error',
+			'no-useless-computed-key': 'error',
 
-		'no-useless-return': 'error',
+			'no-useless-constructor': 'error',
 
-		'no-var': 'error',
+			'no-useless-return': 'error',
 
-		'one-var': [ 'error', 'never' ],
+			'no-var': 'error',
 
-		'prefer-const': [ 'error', { destructuring: 'all' } ],
+			'one-var': [ 'error', 'never' ],
 
-		radix: 'error',
+			'prefer-const': [ 'error', { destructuring: 'all' } ],
 
-		// The result of `typeof` must always be compared to a literal string.
-		'valid-typeof': [
-			'error',
-			{
-				requireStringLiterals: true,
-			},
-		],
-
-		'wrap-iife': [ 'error', 'any' ],
-
-		'promise/always-return': 'off',
-		'promise/avoid-new': 'off',
-		'promise/catch-or-return': 'off',
-		'promise/no-callback-in-promise': 'warn',
-		'promise/no-native': 'off',
-		'promise/no-nesting': 'warn',
-		'promise/no-new-statics': 'error',
-		'promise/no-promise-in-callback': 'warn',
-		'promise/no-return-in-finally': 'error',
-		'promise/no-return-wrap': 'error',
-		'promise/param-names': 'error',
-		'promise/prefer-await-to-callbacks': 'off',
-		'promise/prefer-await-to-then': 'off',
-		'promise/valid-params': 'error',
-
-		// This rule has been disabled because it is extremely slow:
-		// https://github.com/Automattic/vip-cli/pull/1534
-		//
-		// 'promise/no-multiple-resolved': 'error',
-	},
+			radix: 'error',
 
-	settings: {
-		'import/resolver': {
-			node: {
-				extensions: [ '.js', '.jsx', '.ts', '.tsx', '.cjs', '.mjs', '.cts', '.mts' ],
+			// The result of `typeof` must always be compared to a literal string.
+			'valid-typeof': [
+				'error',
+				{
+					requireStringLiterals: true,
+				},
+			],
+
+			'wrap-iife': [ 'error', 'any' ],
+
+			'promise/always-return': 'off',
+			'promise/avoid-new': 'off',
+			'promise/catch-or-return': 'off',
+			'promise/no-callback-in-promise': 'warn',
+			'promise/no-native': 'off',
+			'promise/no-nesting': 'warn',
+			'promise/no-new-statics': 'error',
+			'promise/no-promise-in-callback': 'warn',
+			'promise/no-return-in-finally': 'error',
+			'promise/no-return-wrap': 'error',
+			'promise/param-names': 'error',
+			'promise/prefer-await-to-callbacks': 'off',
+			'promise/prefer-await-to-then': 'off',
+			'promise/valid-params': 'error',
+
+			// This rule has been disabled because it is extremely slow:
+			// https://github.com/Automattic/vip-cli/pull/1534
+			//
+			// 'promise/no-multiple-resolved': 'error',
+		},
+		settings: {
+			'import/resolver': {
+				node: {
+					extensions: [ '.js', '.jsx', '.ts', '.tsx', '.cjs', '.mjs', '.cts', '.mts' ],
+				},
+				typescript: 'eslint-import-resolver-typescript',
 			},
-			typescript: 'eslint-import-resolver-typescript',
 		},
 	},
-};
+];

package/configs/jsdoc.js

@@ -3,6 +3,7 @@
  * https://github.com/WordPress/gutenberg/blob/%40wordpress/eslint-plugin%4014.1.0/packages/eslint-plugin/configs/jsdoc.js
  */
 
+const JsDoc = require( 'eslint-plugin-jsdoc' );
 const globals = require( 'globals' );
 
 /**
@@ -40,68 +41,71 @@ const typescriptUtilityTypes = [
 	'false',
 ];
 
-module.exports = {
-	extends: [ 'plugin:jsdoc/recommended' ],
-	settings: {
-		jsdoc: {
-			preferredTypes: {
-				object: 'Object',
-			},
-			tagNamePreference: {
-				returns: 'return',
-				yields: 'yield',
+/** @type import('eslint').Linter.Config[] */
+module.exports = [
+	JsDoc.configs[ 'flat/recommended' ],
+	{
+		settings: {
+			jsdoc: {
+				preferredTypes: {
+					object: 'Object',
+				},
+				tagNamePreference: {
+					returns: 'return',
+					yields: 'yield',
+				},
 			},
 		},
+		rules: {
+			'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( key => /^[A-Z]/.test( key ) ),
+						...typescriptUtilityTypes,
+						'void',
+						'JSX',
+					],
+				},
+			],
+			'jsdoc/require-jsdoc': 'off',
+			'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': [
+				'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/newline-after-description': '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-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( key => /^[A-Z]/.test( key ) ),
-					...typescriptUtilityTypes,
-					'void',
-					'JSX',
-				],
-			},
-		],
-		'jsdoc/require-jsdoc': 'off',
-		'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': [
-			'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/newline-after-description': '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/prettier.js

@@ -3,10 +3,14 @@
  * https://github.com/WordPress/gutenberg/blob/%40wordpress/eslint-plugin%4014.1.0/packages/eslint-plugin/configs/recommended.js
  */
 
-module.exports = {
-	extends: [ 'plugin:prettier/recommended' ],
-	plugins: [ 'prettier' ],
-	rules: {
-		'prettier/prettier': 'error',
+const eslintPluginPrettierRecommended = require( 'eslint-plugin-prettier/recommended' );
+
+/** @type import('eslint').Linter.Config[] */
+module.exports = [
+	eslintPluginPrettierRecommended,
+	{
+		rules: {
+			'prettier/prettier': 'error',
+		},
 	},
-};
+];