Forbid .range (#2599)

fisker · web-flow · commit dbe2bb285628 · 2025-03-19T23:32:15.000+07:00
diff --git a/eslint.config.js b/eslint.config.js
@@ -2,13 +2,13 @@ import globals from 'globals';
 import xo from 'eslint-config-xo';
 import eslintPlugin from 'eslint-plugin-eslint-plugin';
 import jsdoc from 'eslint-plugin-jsdoc';
-import internal from './scripts/internal-rules/index.js';
+import internalRules from './scripts/internal-rules/index.js';
 import unicorn from './index.js';
 
 const config = [
 	...xo,
 	unicorn.configs.recommended,
-	internal.configs.all,
+	internalRules,
 	{
 		languageOptions: {
 			globals: {
diff --git a/rules/fix/fix-space-around-keywords.js b/rules/fix/fix-space-around-keywords.js
@@ -14,7 +14,7 @@ export default function * fixSpaceAroundKeyword(fixer, node, sourceCode) {
 
 	if (
 		tokenBefore
-		&& range[0] === tokenBefore.range[1]
+		&& range[0] === sourceCode.getRange(tokenBefore)[1]
 		&& isProblematicToken(tokenBefore)
 	) {
 		yield fixer.insertTextAfter(tokenBefore, ' ');
@@ -24,7 +24,7 @@ export default function * fixSpaceAroundKeyword(fixer, node, sourceCode) {
 
 	if (
 		tokenAfter
-		&& range[1] === tokenAfter.range[0]
+		&& range[1] === sourceCode.getRange(tokenAfter)[0]
 		&& isProblematicToken(tokenAfter)
 	) {
 		yield fixer.insertTextBefore(tokenAfter, ' ');
diff --git a/rules/fix/remove-spaces-after.js b/rules/fix/remove-spaces-after.js
@@ -1,7 +1,7 @@
 export default function removeSpacesAfter(indexOrNodeOrToken, sourceCode, fixer) {
 	let index = indexOrNodeOrToken;
-	if (typeof indexOrNodeOrToken === 'object' && Array.isArray(indexOrNodeOrToken.range)) {
-		index = indexOrNodeOrToken.range[1];
+	if (typeof indexOrNodeOrToken === 'object') {
+		index = sourceCode.getRange(indexOrNodeOrToken)[1];
 	}
 
 	const textAfter = sourceCode.text.slice(index);
diff --git a/rules/fix/replace-reference-identifier.js b/rules/fix/replace-reference-identifier.js
@@ -22,6 +22,7 @@ export default function replaceReferenceIdentifier(identifier, replacement, fixe
 	// `typeAnnotation`
 	if (identifier.typeAnnotation) {
 		return fixer.replaceTextRange(
+			// eslint-disable-next-line internal/no-restricted-property-access
 			[identifier.range[0], identifier.typeAnnotation.range[0]],
 			`${replacement}${identifier.optional ? '?' : ''}`,
 		);
diff --git a/rules/fix/replace-string-raw.js b/rules/fix/replace-string-raw.js
@@ -3,7 +3,9 @@ const replaceStringRaw = (fixer, node, raw) =>
 	fixer.replaceTextRange(
 		// Ignore quotes and backticks
 		[
+			// eslint-disable-next-line internal/no-restricted-property-access
 			node.range[0] + 1,
+			// eslint-disable-next-line internal/no-restricted-property-access
 			node.range[1] - 1,
 		],
 		raw,
diff --git a/rules/fix/replace-template-element.js b/rules/fix/replace-template-element.js
@@ -1,4 +1,5 @@
 const replaceTemplateElement = (fixer, node, replacement) => {
+	// eslint-disable-next-line internal/no-restricted-property-access
 	const {range: [start, end], tail} = node;
 	return fixer.replaceTextRange(
 		[start + 1, end - (tail ? 1 : 2)],
diff --git a/rules/no-static-only-class.js b/rules/no-static-only-class.js
@@ -153,7 +153,7 @@ function switchClassToObject(node, sourceCode) {
 				type === 'ClassExpression'
 				&& parent.type === 'ReturnStatement'
 				&& sourceCode.getLoc(body).start.line !== sourceCode.getLoc(parent).start.line
-				&& sourceCode.text.slice(classToken.range[1], body.range[0]).trim()
+				&& sourceCode.text.slice(sourceCode.getRange(classToken)[1], sourceCode.getRange(body)[0]).trim()
 			) {
 				yield fixer.replaceText(classToken, '{');
 
diff --git a/rules/prefer-at.js b/rules/prefer-at.js
@@ -197,9 +197,9 @@ function create(context) {
 				if (
 					tokenBefore.type === 'Punctuator'
 					&& tokenBefore.value === '-'
-					&& /^\s+$/.test(sourceCode.text.slice(tokenBefore.range[1], numberNode.range[0]))
+					&& /^\s+$/.test(sourceCode.text.slice(sourceCode.getRange(tokenBefore)[1], sourceCode.getRange(numberNode)[0]))
 				) {
-					yield fixer.removeRange([tokenBefore.range[1], numberNode.range[0]]);
+					yield fixer.removeRange([sourceCode.getRange(tokenBefore)[1], sourceCode.getRange(numberNode)[0]]);
 				}
 			}
 
@@ -275,7 +275,7 @@ function create(context) {
 			// Remove extra arguments
 			if (sliceCall.arguments.length !== 1) {
 				const [, start] = getParenthesizedRange(sliceCall.arguments[0], sourceCode);
-				const [end] = sourceCode.getLastToken(sliceCall).range;
+				const [end] = sourceCode.getRange(sourceCode.getLastToken(sliceCall));
 				yield fixer.removeRange([start, end]);
 			}
 
diff --git a/rules/prefer-switch.js b/rules/prefer-switch.js
@@ -98,6 +98,7 @@ const getBreakTarget = node => {
 };
 
 const isNodeInsideNode = (inner, outer) =>
+	// eslint-disable-next-line internal/no-restricted-property-access
 	inner.range[0] >= outer.range[0] && inner.range[1] <= outer.range[1];
 function hasBreakInside(breakStatements, node) {
 	for (const breakStatement of breakStatements) {
diff --git a/rules/utils/has-same-range.js b/rules/utils/has-same-range.js
@@ -1,7 +1,9 @@
 const hasSameRange = (node1, node2) =>
 	node1
 	&& node2
+	// eslint-disable-next-line internal/no-restricted-property-access
 	&& node1.range[0] === node2.range[0]
+	// eslint-disable-next-line internal/no-restricted-property-access
 	&& node1.range[1] === node2.range[1];
 
 export default hasSameRange;
diff --git a/rules/utils/parentheses.js b/rules/utils/parentheses.js
@@ -46,8 +46,8 @@ Get the parenthesized range of the node.
 */
 export function getParenthesizedRange(node, sourceCode) {
 	const parentheses = getParentheses(node, sourceCode);
-	const [start] = (parentheses[0] || node).range;
-	const [, end] = (parentheses.at(-1) || node).range;
+	const [start] = sourceCode.getRange(parentheses[0] ?? node);
+	const [, end] = sourceCode.getRange(parentheses.at(-1) ?? node);
 	return [start, end];
 }
 
diff --git a/scripts/internal-rules/index.js b/scripts/internal-rules/index.js
@@ -1,5 +1,4 @@
 import {fileURLToPath} from 'node:url';
-import packageJson from './package.json' with {type: 'json'};
 import fixSnapshotTest from './fix-snapshot-test.js';
 import noTestOnly from './no-test-only.js';
 import preferNegativeBooleanAttribute from './prefer-negative-boolean-attribute.js';
@@ -26,10 +25,10 @@ const rules = [
 
 const isFileInsideDirectory = (filename, directory) => filename.startsWith(directory);
 
-const internal = {
+const plugin = {
 	meta: {
-		name: packageJson.name,
-		version: packageJson.version,
+		name: pluginName,
+		version: '1.0.0',
 	},
 	rules: Object.fromEntries(
 		rules.map(({id, directories, rule}) => [
@@ -49,18 +48,9 @@ const internal = {
 	),
 };
 
-const configs = {
-	all: {
-		plugins: {
-			internal,
-		},
-		rules: Object.fromEntries(rules.map(({id}) => [`${pluginName}/${id}`, 'error'])),
-	},
-};
-
-const allConfigs = {
-	...internal,
-	configs,
+const config = {
+	plugins: {[pluginName]: plugin},
+	rules: Object.fromEntries(rules.map(({id}) => [`${pluginName}/${id}`, 'error'])),
 };
 
-export default allConfigs;
+export default config;
diff --git a/scripts/internal-rules/no-restricted-property-access.js b/scripts/internal-rules/no-restricted-property-access.js
@@ -6,8 +6,7 @@ import {removeMemberExpressionProperty} from '../../rules/fix/index.js';
 const messageId = path.basename(fileURLToPath(import.meta.url), '.js');
 
 const properties = new Map([
-	// Todo: forbid `.range`
-	// ['range', 'sourceCode.getRange'],
+	['range', 'sourceCode.getRange'],
 	['loc', 'sourceCode.getLoc'],
 ]);
 
diff --git a/scripts/internal-rules/package.json b/scripts/internal-rules/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`export default function removeSpacesAfter(indexOrNodeOrToken, sourceCode, fixer) {`
`2`	`2`	`let index = indexOrNodeOrToken;`
`3`		`- if (typeof indexOrNodeOrToken === 'object' && Array.isArray(indexOrNodeOrToken.range)) {`
`4`		`- index = indexOrNodeOrToken.range[1];`
	`3`	`+ if (typeof indexOrNodeOrToken === 'object') {`
	`4`	`+ index = sourceCode.getRange(indexOrNodeOrToken)[1];`
`5`	`5`	`}`
`6`	`6`
`7`	`7`	`const textAfter = sourceCode.text.slice(index);`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`const replaceTemplateElement = (fixer, node, replacement) => {`
	`2`	`+ // eslint-disable-next-line internal/no-restricted-property-access`
`2`	`3`	`const {range: [start, end], tail} = node;`
`3`	`4`	`return fixer.replaceTextRange(`
`4`	`5`	`[start + 1, end - (tail ? 1 : 2)],`
Original file line number	Diff line number	Diff line change
`@@ -197,9 +197,9 @@ function create(context) {`
`197`	`197`	`if (`
`198`	`198`	`tokenBefore.type === 'Punctuator'`
`199`	`199`	`&& tokenBefore.value === '-'`
`200`		`- && /^\s+$/.test(sourceCode.text.slice(tokenBefore.range[1], numberNode.range[0]))`
	`200`	`+ && /^\s+$/.test(sourceCode.text.slice(sourceCode.getRange(tokenBefore)[1], sourceCode.getRange(numberNode)[0]))`
`201`	`201`	`) {`
`202`		`- yield fixer.removeRange([tokenBefore.range[1], numberNode.range[0]]);`
	`202`	`+ yield fixer.removeRange([sourceCode.getRange(tokenBefore)[1], sourceCode.getRange(numberNode)[0]]);`
`203`	`203`	`}`
`204`	`204`	`}`
`205`	`205`
`@@ -275,7 +275,7 @@ function create(context) {`
`275`	`275`	`// Remove extra arguments`
`276`	`276`	`if (sliceCall.arguments.length !== 1) {`
`277`	`277`	`const [, start] = getParenthesizedRange(sliceCall.arguments[0], sourceCode);`
`278`		`- const [end] = sourceCode.getLastToken(sliceCall).range;`
	`278`	`+ const [end] = sourceCode.getRange(sourceCode.getLastToken(sliceCall));`
`279`	`279`	`yield fixer.removeRange([start, end]);`
`280`	`280`	`}`
`281`	`281`