Make GlobalReferenceTracker easier to use (#2768)

Author: fisker

rules/new-for-builtins.js

@@ -16,7 +16,7 @@ const messages = {
 	[MESSAGE_ID_SUGGESTION_DATE]: 'Switch to `String(new Date())`.',
 };
 
-function enforceNewExpression({node, path: [name]}, sourceCode) {
+function enforceNewExpression({node, path: [name]}, {sourceCode}) {
 	if (name === 'Object') {
 		const {parent} = node;
 		if (
@@ -63,7 +63,7 @@ function enforceNewExpression({node, path: [name]}, sourceCode) {
 	};
 }
 
-function enforceCallExpression({node, path: [name]}, sourceCode) {
+function enforceCallExpression({node, path: [name]}, {sourceCode}) {
 	const problem = {
 		node,
 		messageId: 'disallow',
@@ -79,28 +79,21 @@ function enforceCallExpression({node, path: [name]}, sourceCode) {
 	return problem;
 }
 
+const newExpressionTracker = new GlobalReferenceTracker({
+	objects: builtins.disallowNew,
+	type: GlobalReferenceTracker.CONSTRUCT,
+	handle: enforceCallExpression,
+});
+const callExpressionTracker = new GlobalReferenceTracker({
+	objects: builtins.enforceNew,
+	type: GlobalReferenceTracker.CALL,
+	handle: enforceNewExpression,
+});
+
 /** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
-	const {sourceCode} = context;
-	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),
-	});
-
-	return {
-		* 'Program:exit'(program) {
-			const scope = sourceCode.getScope(program);
-
-			yield * newExpressionTracker.track(scope);
-			yield * callExpressionTracker.track(scope);
-		},
-	};
+	newExpressionTracker.listen({context});
+	callExpressionTracker.listen({context});
 };
 
 /** @type {import('eslint').Rule.RuleModule} */

rules/no-document-cookie.js

@@ -13,7 +13,7 @@ const tracker = new GlobalReferenceTracker({
 
 /** @type {import('eslint').Rule.RuleModule} */
 const config = {
-	create: context => tracker.createListeners(context),
+	create: context => tracker.listen({context}),
 	meta: {
 		type: 'problem',
 		docs: {

rules/prefer-number-properties.js

@@ -26,7 +26,7 @@ const isNegative = node => {
 	return parent.type === 'UnaryExpression' && parent.operator === '-' && parent.argument === node;
 };
 
-function checkProperty({node, path: [name]}, sourceCode) {
+function checkProperty({node, path: [name]}, {sourceCode}) {
 	const {parent} = node;
 
 	let property = name;
@@ -81,7 +81,6 @@ const create = context => {
 		checkNaN: true,
 		...context.options[0],
 	};
-	const {sourceCode} = context;
 
 	const objects = Object.keys(globalObjects).filter(name => {
 		if (!checkInfinity && name === 'Infinity') {
@@ -95,13 +94,12 @@ const create = context => {
 		return true;
 	});
 
-	const tracker = new GlobalReferenceTracker({
+	new GlobalReferenceTracker({
 		objects,
-		handle: reference => checkProperty(reference, sourceCode),
+		context,
+		handle: checkProperty,
 		filter: ({node}) => !isLeftHandSide(node),
-	});
-
-	return tracker.createListeners(context);
+	}).listen();
 };
 
 const schema = [

rules/prefer-prototype-methods.js

@@ -125,7 +125,7 @@ function create(context) {
 		callExpressions.push(callExpression);
 	});
 
-	context.on('Program:exit', function * (program) {
+	context.onExit('Program', function * (program) {
 		const globalReferences = new WeakMap();
 
 		const tracker = new ReferenceTracker(sourceCode.getScope(program));

rules/utils/global-reference-tracker.js

@@ -13,50 +13,55 @@ const createTraceMap = (object, type) => {
 
 export class GlobalReferenceTracker {
 	#traceMap = {};
+	#context;
 	#filter;
 	#handle;
 
 	constructor({
 		object,
 		objects = [object],
+		type = ReferenceTracker.READ,
+
+		context,
 		filter,
 		handle,
-		type = ReferenceTracker.READ,
 	}) {
 		for (const object of objects) {
 			Object.assign(this.#traceMap, createTraceMap(object, type));
 		}
 
+		this.#context = context;
 		this.#filter = filter;
 		this.#handle = handle;
 	}
 
-	* track(globalScope) {
+	* #track(globalScope, options) {
+		const context = options?.context ?? this.#context;
+		const filter = options?.filter ?? this.#filter;
+		const handle = options?.handle ?? this.#handle;
 		const tracker = new ReferenceTracker(globalScope);
 
 		for (const reference of tracker.iterateGlobalReferences(this.#traceMap)) {
-			if (this.#filter && !this.#filter(reference)) {
+			if (filter && !filter(reference)) {
 				continue;
 			}
 
-			const problems = this.#handle(reference);
-
-			if (!problems) {
-				continue;
-			}
+			const problems = handle(reference, context);
 
-			if (problems[Symbol.iterator]) {
+			if (problems?.[Symbol.iterator]) {
 				yield * problems;
-			} else {
+			} else if (problems) {
 				yield problems;
 			}
 		}
 	}
 
-	createListeners(context) {
-		return {
-			'Program:exit': program => this.track(context.sourceCode.getScope(program)),
-		};
+	listen(options) {
+		const context = options?.context ?? this.#context;
+		context.onExit(
+			'Program',
+			program => this.#track(context.sourceCode.getScope(program), options),
+		);
 	}
 }