new-for-builtins: Simplify with GlobalReferenceTracker (#1909)

Author: fisker

rules/new-for-builtins.js

@@ -1,5 +1,5 @@
 'use strict';
-const {ReferenceTracker} = require('eslint-utils');
+const {GlobalReferenceTracker} = require('./utils/global-reference-tracker.js');
 const builtins = require('./utils/builtins.js');
 const {
 	switchCallExpressionToNewExpression,
@@ -11,64 +11,65 @@ const messages = {
 	disallow: 'Use `{{name}}()` instead of `new {{name}}()`.',
 };
 
-function * enforceNewExpression({sourceCode, tracker}) {
-	const traceMap = Object.fromEntries(
-		builtins.enforceNew.map(name => [name, {[ReferenceTracker.CALL]: true}]),
-	);
-
-	for (const {node, path: [name]} of tracker.iterateGlobalReferences(traceMap)) {
-		if (name === 'Object') {
-			const {parent} = node;
-			if (
-				parent.type === 'BinaryExpression'
-				&& (parent.operator === '===' || parent.operator === '!==')
-				&& (parent.left === node || parent.right === node)
-			) {
-				continue;
-			}
+function enforceNewExpression({node, path: [name]}, sourceCode) {
+	if (name === 'Object') {
+		const {parent} = node;
+		if (
+			parent.type === 'BinaryExpression'
+			&& (parent.operator === '===' || parent.operator === '!==')
+			&& (parent.left === node || parent.right === node)
+		) {
+			return;
 		}
-
-		yield {
-			node,
-			messageId: 'enforce',
-			data: {name},
-			fix: fixer => switchCallExpressionToNewExpression(node, sourceCode, fixer),
-		};
 	}
+
+	return {
+		node,
+		messageId: 'enforce',
+		data: {name},
+		fix: fixer => switchCallExpressionToNewExpression(node, sourceCode, fixer),
+	};
 }
 
-function * enforceCallExpression({sourceCode, tracker}) {
-	const traceMap = Object.fromEntries(
-		builtins.disallowNew.map(name => [name, {[ReferenceTracker.CONSTRUCT]: true}]),
-	);
+function enforceCallExpression({node, path: [name]}, sourceCode) {
+	const problem = {
+		node,
+		messageId: 'disallow',
+		data: {name},
+	};
 
-	for (const {node, path: [name]} of tracker.iterateGlobalReferences(traceMap)) {
-		const problem = {
-			node,
-			messageId: 'disallow',
-			data: {name},
+	if (name !== 'String' && name !== 'Boolean' && name !== 'Number') {
+		problem.fix = function * (fixer) {
+			yield * switchNewExpressionToCallExpression(node, sourceCode, fixer);
 		};
-
-		if (name !== 'String' && name !== 'Boolean' && name !== 'Number') {
-			problem.fix = function * (fixer) {
-				yield * switchNewExpressionToCallExpression(node, sourceCode, fixer);
-			};
-		}
-
-		yield problem;
 	}
+
+	return problem;
 }
 
 /** @param {import('eslint').Rule.RuleContext} context */
-const create = context => ({
-	* 'Program:exit'() {
-		const sourceCode = context.getSourceCode();
-		const tracker = new ReferenceTracker(context.getScope());
+const create = context => {
+	const sourceCode = context.getSourceCode();
+	const newExpressionTracker = new GlobalReferenceTracker({
+		objects: builtins.disallowNew,
+		type: GlobalReferenceTracker.CONSTRUCT,
+		handle: reference => enforceCallExpression(reference, sourceCode),
+	});
+	const callExpressionTracker = new GlobalReferenceTracker({
+		objects: builtins.enforceNew,
+		type: GlobalReferenceTracker.CALL,
+		handle: reference => enforceNewExpression(reference, sourceCode),
+	});
 
-		yield * enforceNewExpression({sourceCode, tracker});
-		yield * enforceCallExpression({sourceCode, tracker});
-	},
-});
+	return {
+		* 'Program:exit'() {
+			const scope = context.getScope();
+
+			yield * newExpressionTracker.track(scope);
+			yield * callExpressionTracker.track(scope);
+		},
+	};
+};
 
 /** @type {import('eslint').Rule.RuleModule} */
 module.exports = {

rules/utils/global-reference-tracker.js

@@ -1,8 +1,8 @@
 'use strict';
 const {ReferenceTracker} = require('eslint-utils');
 
-const createTraceMap = object => {
-	let map = {[ReferenceTracker.READ]: true};
+const createTraceMap = (object, type) => {
+	let map = {[type]: true};
 
 	const path = object.split('.').reverse();
 	for (const name of path) {
@@ -22,9 +22,10 @@ class GlobalReferenceTracker {
 		objects = [object],
 		filter,
 		handle,
+		type = ReferenceTracker.READ,
 	}) {
 		for (const object of objects) {
-			Object.assign(this.#traceMap, createTraceMap(object));
+			Object.assign(this.#traceMap, createTraceMap(object, type));
 		}
 
 		this.#filter = filter;
@@ -60,6 +61,12 @@ class GlobalReferenceTracker {
 	}
 }
 
+Object.assign(GlobalReferenceTracker, {
+	READ: ReferenceTracker.READ,
+	CALL: ReferenceTracker.CALL,
+	CONSTRUCT: ReferenceTracker.CONSTRUCT,
+});
+
 module.exports = {
 	GlobalReferenceTracker,
 };