@automattic/eslint-plugin-wpvip 0.5.0 → 0.5.2

package/configs/base.js

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

package/configs/index.js

@@ -1,5 +1,5 @@
 module.exports = {
-	base: require('./javascript'), // synonym for javascript
+	base: require('./base'), // synonym for javascript
 	cli: require('./cli'),
 	formatting: require('./formatting'),
 	javascript: require('./javascript'),

package/configs/javascript.js

@@ -100,10 +100,6 @@ module.exports = {
 		// will not be awaited in the outer scope.
 		'@automattic/wpvip/no-async-foreach': 'error',
 
-		// Variables that are potentially not needed before a return statement can
-		// be assigned after the return.
-		'@automattic/wpvip/no-unused-vars-before-return': 'error',
-
 		// Unguarded getRangeAt calls can throw errors in some browsers.
 		'@automattic/wpvip/no-unguarded-get-range-at': 'error',
 
@@ -207,4 +203,13 @@ module.exports = {
 
 		'wrap-iife': ['error', 'any'],
 	},
+
+	settings: {
+		'import/resolver': {
+			node: {
+				extensions: ['.js', '.jsx', '.ts', '.tsx'],
+			},
+			typescript: 'eslint-import-resolver-typescript',
+		},
+	},
 };

package/configs/react.js

@@ -7,7 +7,7 @@ module.exports = {
 	extends: [
 		'plugin:react/recommended',
 		'plugin:react-hooks/recommended',
-		require('./jsx-ally'),
+		'plugin:jsx-a11y/recommended',
 	],
 
 	parserOptions: {
@@ -22,16 +22,24 @@ module.exports = {
 		},
 	},
 
-	plugins: ['@automattic/wpvip', 'react', 'react-hooks'],
+	plugins: ['@automattic/wpvip', 'jsx-a11y', 'react', 'react-hooks'],
 
 	rules: {
-		'@automattic/wpvip/no-unused-vars-before-return': [
+		'jsx-a11y/label-has-associated-control': [
 			'error',
 			{
-				excludePattern: '^use',
+				assert: 'htmlFor',
 			},
 		],
 
+		'jsx-a11y/media-has-caption': 'off',
+
+		'jsx-a11y/no-noninteractive-tabindex': 'off',
+
+		'jsx-a11y/role-has-required-aria-props': 'off',
+
+		'jsx-quotes': 'error',
+
 		'react/display-name': 'off',
 
 		'react/jsx-curly-spacing': [

package/configs/typescript.js

@@ -50,13 +50,4 @@ module.exports = {
 	],
 
 	plugins: ['@typescript-eslint', 'jsdoc'],
-
-	settings: {
-		'import/parsers': {
-			'@typescript-eslint/parser': ['.ts', '.tsx'],
-		},
-		'import/resolver': {
-			typescript: {},
-		},
-	},
 };

package/configs/weak-javascript.js

@@ -17,8 +17,6 @@ module.exports = {
 			 * to "off"). If a rule is already set to a warning, do not disable it.
 			 */
 			rules: {
-				'@automattic/wpvip/no-unused-vars-before-return': 'warn',
-
 				complexity: 'warn',
 
 				eqeqeq: 'warn',

package/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+	preset: 'ts-jest',
+	testEnvironment: 'node',
+};

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@automattic/eslint-plugin-wpvip",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "ESLint plugin for internal WordPress VIP projects",
   "main": "index.js",
   "scripts": {
-    "jest": "jest",
+    "check-types": "tsc __tests__/**/*.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",
     "lint": "npm run link-plugin && eslint .",
-    "test": "jest"
+    "test": "npm run jest"
   },
   "repository": {
     "type": "git",
@@ -47,9 +48,13 @@
     "eslint": ">=8"
   },
   "devDependencies": {
+    "@tsconfig/node18": "1.0.1",
+    "@types/eslint": "8.37.0",
+    "@types/jest": "29.5.0",
     "eslint": "8.35.0",
     "jest": "29.5.0",
     "prettier": "2.8.4",
+    "ts-jest": "29.0.5",
     "typescript": "4.9.5"
   }
 }

package/rules/index.js

@@ -5,5 +5,4 @@ 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'),
-	'no-unused-vars-before-return': require('./no-unused-vars-before-return'),
 };

package/configs/jsx-ally.js

@@ -1,21 +0,0 @@
-/**
- * Based on:
- * https://github.com/WordPress/gutenberg/blob/%40wordpress/eslint-plugin%4014.1.0/packages/eslint-plugin/configs/jsx-a11y.js
- */
-
-module.exports = {
-	extends: ['plugin:jsx-a11y/recommended'],
-	plugins: ['jsx-a11y'],
-	rules: {
-		'jsx-a11y/label-has-associated-control': [
-			'error',
-			{
-				assert: 'htmlFor',
-			},
-		],
-		'jsx-a11y/media-has-caption': 'off',
-		'jsx-a11y/no-noninteractive-tabindex': 'off',
-		'jsx-a11y/role-has-required-aria-props': 'off',
-		'jsx-quotes': 'error',
-	},
-};

package/rules/no-unused-vars-before-return.js

@@ -1,155 +0,0 @@
-/**
- * From:
- * https://github.com/WordPress/gutenberg/blob/%40wordpress/eslint-plugin%4014.1.0/packages/eslint-plugin/rules/no-unused-vars-before-return.js
- */
-
-/** @typedef {import('eslint').Scope.Scope} ESLintScope */
-/** @typedef {import('eslint').Rule.RuleContext} ESLintRuleContext */
-/** @typedef {import('estree').Node} ESTreeNode */
-
-/**
- * Mapping of function scope objects to a set of identified JSX identifiers
- * within that scope.
- *
- * @type {WeakMap<ESLintScope,Set<ESTreeNode>>}
- */
-const FUNCTION_SCOPE_JSX_IDENTIFIERS = new WeakMap();
-
-/**
- * Returns the closest function scope for the current ESLint context object, or
- * undefined if it cannot be determined.
- *
- * @param {ESLintRuleContext} context ESLint context object.
- *
- * @return {ESLintScope|undefined} Function scope, if known.
- */
-function getClosestFunctionScope(context) {
-	let functionScope = context.getScope();
-	while (functionScope.type !== 'function' && functionScope.upper) {
-		functionScope = functionScope.upper;
-	}
-
-	return functionScope;
-}
-
-module.exports = /** @type {import('eslint').Rule} */ ({
-	meta: {
-		type: 'problem',
-		schema: [
-			{
-				type: 'object',
-				properties: {
-					excludePattern: {
-						type: 'string',
-					},
-				},
-				additionalProperties: false,
-			},
-		],
-	},
-	/**
-	 * @param {ESLintRuleContext} context Rule context.
-	 */
-	create(context) {
-		const options = context.options[0] || {};
-		const { excludePattern } = options;
-
-		/**
-		 * Given an Espree VariableDeclarator node, returns true if the node
-		 * can be exempted from consideration as unused, or false otherwise. A
-		 * node can be exempt if it destructures to multiple variables, since
-		 * those other variables may be used prior to the return statement. A
-		 * future enhancement could validate that they are in-fact referenced.
-		 *
-		 * @param {Object} node Node to test.
-		 *
-		 * @return {boolean} Whether declarator is emempt from consideration.
-		 */
-		function isExemptObjectDestructureDeclarator(node) {
-			return node.id.type === 'ObjectPattern' && node.id.properties.length > 1;
-		}
-
-		return {
-			JSXIdentifier(node) {
-				// Currently, a scope's variable references does not include JSX
-				// identifiers. Account for this by visiting JSX identifiers
-				// first, and tracking them in a map per function scope, which
-				// is later merged with the known variable references.
-				const functionScope = getClosestFunctionScope(context);
-				if (!functionScope) {
-					return;
-				}
-
-				if (!FUNCTION_SCOPE_JSX_IDENTIFIERS.has(functionScope)) {
-					FUNCTION_SCOPE_JSX_IDENTIFIERS.set(functionScope, new Set());
-				}
-
-				FUNCTION_SCOPE_JSX_IDENTIFIERS.get(functionScope).add(node);
-			},
-			'ReturnStatement:exit'(node) {
-				const functionScope = getClosestFunctionScope(context);
-				if (!functionScope) {
-					return;
-				}
-
-				for (const variable of functionScope.variables) {
-					const declaratorCandidate = variable.defs.find((def) => {
-						return (
-							def.node.type === 'VariableDeclarator' &&
-							// Allow declarations which are not initialized.
-							def.node.init &&
-							// Target function calls as "expensive".
-							def.node.init.type === 'CallExpression' &&
-							// Allow unused if part of an object destructuring.
-							!isExemptObjectDestructureDeclarator(def.node) &&
-							// Only target assignments preceding `return`.
-							def.node.range[1] < node.range[1]
-						);
-					});
-
-					if (!declaratorCandidate) {
-						continue;
-					}
-
-					if (
-						excludePattern !== undefined &&
-						// eslint-disable-next-line security/detect-non-literal-regexp
-						new RegExp(excludePattern).test(
-							declaratorCandidate.node.init.callee.name
-						)
-					) {
-						continue;
-					}
-
-					// The first entry in `references` is the declaration
-					// itself, which can be ignored.
-					const identifiers = variable.references
-						.slice(1)
-						.map((reference) => reference.identifier);
-
-					// Merge with any JSX identifiers in scope, if any.
-					if (FUNCTION_SCOPE_JSX_IDENTIFIERS.has(functionScope)) {
-						const jsxIdentifiers =
-							FUNCTION_SCOPE_JSX_IDENTIFIERS.get(functionScope);
-
-						identifiers.push(...jsxIdentifiers);
-					}
-
-					const isUsedBeforeReturn = identifiers.some(
-						(identifier) => identifier.range[1] < node.range[1]
-					);
-
-					if (isUsedBeforeReturn) {
-						continue;
-					}
-
-					context.report(
-						declaratorCandidate.node,
-						'Variables should not be assigned until just prior its first reference. ' +
-							'An early return statement may leave this variable unused.'
-					);
-				}
-			},
-		};
-	},
-});