Replace .loc with sourceCode.getLoc() (#2558)

fisker · web-flow · commit 1e4b03063379 · 2025-02-18T01:15:21.000+07:00
diff --git a/eslint.dogfooding.config.js b/eslint.dogfooding.config.js
@@ -6,23 +6,16 @@ import eslintPluginUnicorn from './index.js';
 
 const config = [
 	eslintPluginUnicorn.configs.all,
+	disableExternalRules([
+		// If external rules needs to be disabled, add the rule name here.
+		'n/no-unsupported-features/es-syntax',
+		'eslint-plugin/require-meta-default-options',
+		'internal/no-restricted-property-access',
+	]),
 	{
 		linterOptions: {
 			reportUnusedDisableDirectives: false,
 		},
-		// Fake rule to allow inline config to disable
-		plugins: {
-			n: {
-				rules: {
-					'no-unsupported-features/es-syntax': {},
-				},
-			},
-			'eslint-plugin': {
-				rules: {
-					'require-meta-default-options': {},
-				},
-			},
-		},
 	},
 	{
 		ignores: [
@@ -56,4 +49,17 @@ const config = [
 	},
 ];
 
+// Create rule to allow inline config to disable
+function disableExternalRules(rules) {
+	const plugins = {};
+	for (const rule of rules) {
+		const [pluginName, ...rest] = rule.split('/');
+		const ruleName = rest.join('/');
+		plugins[pluginName] ??= {rules: {}};
+		plugins[pluginName].rules[ruleName] ??= {};
+	}
+
+	return {plugins};
+}
+
 export default config;
diff --git a/rules/consistent-date-clone.js b/rules/consistent-date-clone.js
@@ -24,11 +24,15 @@ const create = context => ({
 			return;
 		}
 
+		const {sourceCode} = context;
 		return {
 			node: callExpression,
-			loc: {start: callExpression.callee.property.loc.start, end: callExpression.loc.end},
+			loc: {
+				start: sourceCode.getLoc(callExpression.callee.property).start,
+				end: sourceCode.getLoc(callExpression).end,
+			},
 			messageId: MESSAGE_ID_ERROR,
-			fix: fixer => removeMethodCall(fixer, callExpression, context.sourceCode),
+			fix: fixer => removeMethodCall(fixer, callExpression, sourceCode),
 		};
 	},
 });
diff --git a/rules/empty-brace-spaces.js b/rules/empty-brace-spaces.js
@@ -22,8 +22,8 @@ const getProblem = (node, context) => {
 
 	return {
 		loc: {
-			start: openingBrace.loc.end,
-			end: closingBrace.loc.start,
+			start: sourceCode.getLoc(openingBrace).end,
+			end: sourceCode.getLoc(closingBrace).start,
 		},
 		messageId: MESSAGE_ID,
 		fix: fixer => fixer.removeRange([start, end]),
diff --git a/rules/expiring-todo-comments.js b/rules/expiring-todo-comments.js
@@ -354,7 +354,7 @@ const create = context => {
 		if (dates.length > 1) {
 			uses++;
 			context.report({
-				loc: comment.loc,
+				loc: sourceCode.getLoc(comment),
 				messageId: MESSAGE_ID_AVOID_MULTIPLE_DATES,
 				data: {
 					expirationDates: dates.join(', '),
@@ -368,7 +368,7 @@ const create = context => {
 			const shouldIgnore = options.ignoreDatesOnPullRequests && ci.isPR;
 			if (!shouldIgnore && reachedDate(expirationDate, options.date)) {
 				context.report({
-					loc: comment.loc,
+					loc: sourceCode.getLoc(comment),
 					messageId: MESSAGE_ID_EXPIRED_TODO,
 					data: {
 						expirationDate,
@@ -381,7 +381,7 @@ const create = context => {
 		if (packageVersions.length > 1) {
 			uses++;
 			context.report({
-				loc: comment.loc,
+				loc: sourceCode.getLoc(comment),
 				messageId: MESSAGE_ID_AVOID_MULTIPLE_PACKAGE_VERSIONS,
 				data: {
 					versions: packageVersions
@@ -400,7 +400,7 @@ const create = context => {
 			const compare = semverComparisonForOperator(condition);
 			if (packageVersion && compare(packageVersion, decidedPackageVersion)) {
 				context.report({
-					loc: comment.loc,
+					loc: sourceCode.getLoc(comment),
 					messageId: MESSAGE_ID_REACHED_PACKAGE_VERSION,
 					data: {
 						comparison: `${condition}${version}`,
@@ -426,7 +426,7 @@ const create = context => {
 
 				if (trigger) {
 					context.report({
-						loc: comment.loc,
+						loc: sourceCode.getLoc(comment),
 						messageId,
 						data: {
 							package: dependency.name,
@@ -452,7 +452,7 @@ const create = context => {
 
 			if (compare(targetPackageVersion, todoVersion)) {
 				context.report({
-					loc: comment.loc,
+					loc: sourceCode.getLoc(comment),
 					messageId: MESSAGE_ID_VERSION_MATCHES,
 					data: {
 						comparison: `${dependency.name} ${dependency.condition} ${dependency.version}`,
@@ -484,7 +484,7 @@ const create = context => {
 
 			if (compare(targetPackageEngineVersion, todoEngine)) {
 				context.report({
-					loc: comment.loc,
+					loc: sourceCode.getLoc(comment),
 					messageId: MESSAGE_ID_ENGINE_MATCHES,
 					data: {
 						comparison: `node${engine.condition}${engine.version}`,
@@ -508,7 +508,7 @@ const create = context => {
 				if (parseArgument(testString).type !== 'unknowns') {
 					uses++;
 					context.report({
-						loc: comment.loc,
+						loc: sourceCode.getLoc(comment),
 						messageId: MESSAGE_ID_MISSING_AT_SYMBOL,
 						data: {
 							original: unknown,
@@ -525,7 +525,7 @@ const create = context => {
 			if (parseArgument(withoutWhitespace).type !== 'unknowns') {
 				uses++;
 				context.report({
-					loc: comment.loc,
+					loc: sourceCode.getLoc(comment),
 					messageId: MESSAGE_ID_REMOVE_WHITESPACE,
 					data: {
 						original: unknown,
diff --git a/rules/no-abusive-eslint-disable.js b/rules/no-abusive-eslint-disable.js
@@ -6,7 +6,7 @@ const messages = {
 const disableRegex = /^eslint-disable(?:-next-line|-line)?(?<ruleId>$|(?:\s+(?:@(?:[\w-]+\/){1,2})?[\w-]+)?)/;
 
 /** @param {import('eslint').Rule.RuleContext} context */
-const create = () => ({
+const create = context => ({
 	* Program(node) {
 		for (const comment of node.comments) {
 			const value = comment.value.trim();
@@ -16,15 +16,17 @@ const create = () => ({
 				result // It's a eslint-disable comment
 				&& !result.groups.ruleId // But it did not specify any rules
 			) {
+				const {sourceCode} = context;
+
 				yield {
 					// Can't set it at the given location as the warning
 					// will be ignored due to the disable comment
 					loc: {
 						start: {
-							...comment.loc.start,
+							...sourceCode.getLoc(comment).start,
 							column: -1,
 						},
-						end: comment.loc.end,
+						end: sourceCode.getLoc(comment).end,
 					},
 					messageId: MESSAGE_ID,
 				};
diff --git a/rules/no-for-loop.js b/rules/no-for-loop.js
@@ -164,7 +164,7 @@ const getRemovalRange = (node, sourceCode) => {
 	const declarationNode = node.parent;
 
 	if (declarationNode.declarations.length === 1) {
-		const {line} = declarationNode.loc.start;
+		const {line} = sourceCode.getLoc(declarationNode).start;
 		const lineText = sourceCode.lines[line - 1];
 
 		const isOnlyNodeOnLine = lineText.trim() === sourceCode.getText(declarationNode);
diff --git a/rules/no-static-only-class.js b/rules/no-static-only-class.js
@@ -152,7 +152,7 @@ function switchClassToObject(node, sourceCode) {
 			if (
 				type === 'ClassExpression'
 				&& parent.type === 'ReturnStatement'
-				&& body.loc.start.line !== parent.loc.start.line
+				&& sourceCode.getLoc(body).start.line !== sourceCode.getLoc(parent).start.line
 				&& sourceCode.text.slice(classToken.range[1], body.range[0]).trim()
 			) {
 				yield fixer.replaceText(classToken, '{');
diff --git a/rules/no-typeof-undefined.js b/rules/no-typeof-undefined.js
@@ -93,7 +93,7 @@ const create = context => {
 
 			const problem = {
 				node: binaryExpression,
-				loc: typeofToken.loc,
+				loc: sourceCode.getLoc(typeofToken),
 				messageId: MESSAGE_ID_ERROR,
 			};
 
diff --git a/rules/no-unnecessary-await.js b/rules/no-unnecessary-await.js
@@ -46,7 +46,7 @@ const create = context => ({
 		const awaitToken = sourceCode.getFirstToken(node);
 		const problem = {
 			node,
-			loc: awaitToken.loc,
+			loc: sourceCode.getLoc(awaitToken),
 			messageId: MESSAGE_ID,
 		};
 
diff --git a/rules/no-useless-length-check.js b/rules/no-useless-length-check.js
@@ -102,17 +102,17 @@ const create = context => {
 					getUselessLengthCheckNode(logicalExpression),
 				),
 			);
+			const {sourceCode} = context;
 
 			for (const node of nodes) {
 				yield {
 					loc: {
-						start: node.left.property.loc.start,
-						end: node.loc.end,
+						start: sourceCode.getLoc(node.left.property).start,
+						end: sourceCode.getLoc(node).end,
 					},
 					messageId: zeroLengthChecks.has(node) ? 'zero' : 'non-zero',
 					/** @param {import('eslint').Rule.RuleFixer} fixer */
 					fix(fixer) {
-						const {sourceCode} = context;
 						const {left, right} = node.parent;
 						const leftRange = getParenthesizedRange(left, sourceCode);
 						const rightRange = getParenthesizedRange(right, sourceCode);
diff --git a/rules/no-useless-undefined.js b/rules/no-useless-undefined.js
@@ -251,8 +251,8 @@ const create = context => {
 		return {
 			messageId,
 			loc: {
-				start: firstUndefined.loc.start,
-				end: lastUndefined.loc.end,
+				start: sourceCode.getLoc(firstUndefined).start,
+				end: sourceCode.getLoc(lastUndefined).end,
 			},
 			fix(fixer) {
 				let [start] = sourceCode.getRange(firstUndefined);
diff --git a/rules/prefer-array-flat-map.js b/rules/prefer-array-flat-map.js
@@ -46,7 +46,10 @@ const create = context => ({
 
 		return {
 			node: flatCallExpression,
-			loc: {start: mapProperty.loc.start, end: flatCallExpression.loc.end},
+			loc: {
+				start: sourceCode.getLoc(mapProperty).start,
+				end: sourceCode.getLoc(flatCallExpression).end,
+			},
 			messageId: MESSAGE_ID,
 			* fix(fixer) {
 				// Removes:
diff --git a/rules/prefer-default-parameters.js b/rules/prefer-default-parameters.js
@@ -91,8 +91,8 @@ const needsParentheses = (sourceCode, function_) => {
 
 /** @param {import('eslint').Rule.RuleFixer} fixer */
 const fixDefaultExpression = (fixer, sourceCode, node) => {
-	const {line} = node.loc.start;
-	const {column} = node.loc.end;
+	const {line} = sourceCode.getLoc(node).start;
+	const {column} = sourceCode.getLoc(node).end;
 	const nodeText = sourceCode.getText(node);
 	const lineText = sourceCode.lines[line - 1];
 	const isOnlyNodeOnLine = lineText.trim() === nodeText;
diff --git a/rules/prefer-string-raw.js b/rules/prefer-string-raw.js
@@ -52,13 +52,14 @@ const create = context => {
 			return;
 		}
 
+		const {sourceCode} = context;
 		const {raw} = node;
 		if (
 			raw.at(-2) === BACKSLASH
 			|| !raw.includes(BACKSLASH + BACKSLASH)
 			|| raw.includes('`')
 			|| raw.includes('${')
-			|| node.loc.start.line !== node.loc.end.line
+			|| sourceCode.getLoc(node).start.line !== sourceCode.getLoc(node).end.line
 		) {
 			return;
 		}
@@ -73,7 +74,7 @@ const create = context => {
 			messageId: MESSAGE_ID,
 			* fix(fixer) {
 				yield fixer.replaceText(node, `String.raw\`${unescaped}\``);
-				yield * fixSpaceAroundKeyword(fixer, node, context.sourceCode);
+				yield * fixSpaceAroundKeyword(fixer, node, sourceCode);
 			},
 		};
 	});
diff --git a/rules/prefer-structured-clone.js b/rules/prefer-structured-clone.js
@@ -47,12 +47,13 @@ const create = context => {
 
 		const jsonParse = callExpression;
 		const jsonStringify = callExpression.arguments[0];
+		const {sourceCode} = context;
 
 		return {
 			node: jsonParse,
 			loc: {
-				start: jsonParse.loc.start,
-				end: jsonStringify.callee.loc.end,
+				start: sourceCode.getLoc(jsonParse).start,
+				end: sourceCode.getLoc(jsonStringify.callee).end,
 			},
 			messageId: MESSAGE_ID_ERROR,
 			data: {
@@ -64,8 +65,6 @@ const create = context => {
 					* fix(fixer) {
 						yield fixer.replaceText(jsonParse.callee, 'structuredClone');
 
-						const {sourceCode} = context;
-
 						yield fixer.remove(jsonStringify.callee);
 						yield * removeParentheses(jsonStringify.callee, fixer, sourceCode);
 
diff --git a/rules/prefer-switch.js b/rules/prefer-switch.js
@@ -290,8 +290,8 @@ const create = context => {
 
 				const problem = {
 					loc: {
-						start: node.loc.start,
-						end: node.consequent.loc.start,
+						start: sourceCode.getLoc(node).start,
+						end: sourceCode.getLoc(node.consequent).start,
 					},
 					messageId: MESSAGE_ID,
 				};
diff --git a/rules/prefer-ternary.js b/rules/prefer-ternary.js
@@ -34,6 +34,7 @@ function getNodeBody(node) {
 	return node;
 }
 
+// eslint-disable-next-line internal/no-restricted-property-access -- Need fix
 const isSingleLineNode = node => node.loc.start.line === node.loc.end.line;
 
 /** @param {import('eslint').Rule.RuleContext} context */
diff --git a/rules/require-array-join-separator.js b/rules/require-array-join-separator.js
@@ -38,8 +38,8 @@ const create = context => ({
 		const isPrototypeMethod = node.arguments.length === 1;
 		return {
 			loc: {
-				start: penultimateToken.loc[isPrototypeMethod ? 'end' : 'start'],
-				end: lastToken.loc.end,
+				start: sourceCode.getLoc(penultimateToken)[isPrototypeMethod ? 'end' : 'start'],
+				end: sourceCode.getLoc(lastToken).end,
 			},
 			messageId: MESSAGE_ID,
 			/** @param {import('eslint').Rule.RuleFixer} fixer */
diff --git a/rules/require-number-to-fixed-digits-argument.js b/rules/require-number-to-fixed-digits-argument.js
@@ -29,8 +29,8 @@ const create = context => ({
 
 		return {
 			loc: {
-				start: openingParenthesis.loc.start,
-				end: closingParenthesis.loc.end,
+				start: sourceCode.getLoc(openingParenthesis).start,
+				end: sourceCode.getLoc(closingParenthesis).end,
 			},
 			messageId: MESSAGE_ID,
 			/** @param {import('eslint').Rule.RuleFixer} fixer */
diff --git a/rules/require-post-message-target-origin.js b/rules/require-post-message-target-origin.js
@@ -41,8 +41,8 @@ function create(context) {
 
 			return {
 				loc: {
-					start: penultimateToken.loc.end,
-					end: lastToken.loc.end,
+					start: sourceCode.getLoc(penultimateToken).end,
+					end: sourceCode.getLoc(lastToken).end,
 				},
 				messageId: ERROR,
 				suggest: replacements.map(code => ({
diff --git a/rules/switch-case-braces.js b/rules/switch-case-braces.js
@@ -52,7 +52,7 @@ const create = context => {
 			) {
 				return {
 					node,
-					loc: sourceCode.getFirstToken(consequent[0]).loc,
+					loc: sourceCode.getLoc(sourceCode.getFirstToken(consequent[0])),
 					messageId: MESSAGE_ID_EMPTY_CLAUSE,
 					fix: fixer => removeBraces(fixer, node, sourceCode),
 				};
@@ -84,7 +84,7 @@ const create = context => {
 			) {
 				return {
 					node,
-					loc: sourceCode.getFirstToken(consequent[0]).loc,
+					loc: sourceCode.getLoc(sourceCode.getFirstToken(consequent[0])),
 					messageId: MESSAGE_ID_UNNECESSARY_BRACES,
 					fix: fixer => removeBraces(fixer, node, sourceCode),
 				};
diff --git a/rules/template-indent.js b/rules/template-indent.js
diff --git a/rules/utils/get-class-head-location.js b/rules/utils/get-class-head-location.js
diff --git a/rules/utils/get-switch-case-head-location.js b/rules/utils/get-switch-case-head-location.js
diff --git a/rules/utils/is-on-same-line.js b/rules/utils/is-on-same-line.js
diff --git a/scripts/internal-rules/index.js b/scripts/internal-rules/index.js
diff --git a/scripts/internal-rules/no-restricted-property-access.js b/scripts/internal-rules/no-restricted-property-access.js
