Rename avoidCapture to getAvailableVariableName (#2539)

Author: fisker

rules/catch-error-name.js

@@ -1,6 +1,6 @@
 import {isRegExp} from 'node:util/types';
 import {findVariable} from '@eslint-community/eslint-utils';
-import avoidCapture from './utils/avoid-capture.js';
+import {getAvailableVariableName} from './utils/index.js';
 import {renameVariable} from './fix/index.js';
 import {isMethodCall} from './ast/index.js';
 
@@ -85,7 +85,7 @@ const create = context => {
 				variable.scope,
 				...variable.references.map(({from}) => from),
 			];
-			const fixedName = avoidCapture(expectedName, scopes);
+			const fixedName = getAvailableVariableName(expectedName, scopes);
 
 			const problem = {
 				node,

rules/consistent-destructuring.js

@@ -1,5 +1,4 @@
-import avoidCapture from './utils/avoid-capture.js';
-import isLeftHandSide from './utils/is-left-hand-side.js';
+import {getAvailableVariableName, isLeftHandSide} from './utils/index.js';
 import {isCallOrNewExpression} from './ast/index.js';
 
 const MESSAGE_ID = 'consistentDestructuring';
@@ -107,7 +106,7 @@ const create = context => {
 				}
 
 				// Destructured member collides with an existing identifier
-				if (avoidCapture(member, [memberScope]) !== member) {
+				if (getAvailableVariableName(member, [memberScope]) !== member) {
 					return;
 				}
 			}

rules/no-anonymous-default-export.js

@@ -4,7 +4,7 @@ import helperValidatorIdentifier from '@babel/helper-validator-identifier';
 import getClassHeadLocation from './utils/get-class-head-location.js';
 import {upperFirst, camelCase} from './utils/lodash.js';
 import {getParenthesizedRange} from './utils/parentheses.js';
-import {getScopes, avoidCapture} from './utils/index.js';
+import {getScopes, getAvailableVariableName} from './utils/index.js';
 import {isMemberExpression} from './ast/index.js';
 
 const {isIdentifierName} = helperValidatorIdentifier;
@@ -42,7 +42,7 @@ function getSuggestionName(node, filename, sourceCode) {
 	}
 
 	name = node.type === 'ClassDeclaration' || node.type === 'ClassExpression' ? upperFirst(name) : name;
-	name = avoidCapture(name, getScopes(sourceCode.getScope(node)));
+	name = getAvailableVariableName(name, getScopes(sourceCode.getScope(node)));
 
 	return name;
 }

rules/no-for-loop.js

@@ -1,9 +1,11 @@
 import {isClosingParenToken, getStaticValue} from '@eslint-community/eslint-utils';
-import avoidCapture from './utils/avoid-capture.js';
-import getScopes from './utils/get-scopes.js';
-import singular from './utils/singular.js';
-import toLocation from './utils/to-location.js';
-import getReferences from './utils/get-references.js';
+import {
+	getAvailableVariableName,
+	getScopes,
+	singular,
+	toLocation,
+	getReferences,
+} from './utils/index.js';
 import {isLiteral} from './ast/index.js';
 
 const MESSAGE_ID = 'no-for-loop';
@@ -348,7 +350,7 @@ const create = context => {
 					const shouldGenerateIndex = isIndexVariableUsedElsewhereInTheLoopBody(indexVariable, bodyScope, arrayIdentifierName);
 					const index = indexIdentifierName;
 					const element = elementIdentifierName
-						|| avoidCapture(singular(arrayIdentifierName) || defaultElementName, getScopes(bodyScope));
+						|| getAvailableVariableName(singular(arrayIdentifierName) || defaultElementName, getScopes(bodyScope));
 					const array = arrayIdentifierName;
 
 					let declarationElement = element;

rules/prefer-array-find.js

@@ -9,7 +9,7 @@ import {
 	isLeftHandSide,
 	singular,
 	getScopes,
-	avoidCapture,
+	getAvailableVariableName,
 	getVariableIdentifiers,
 } from './utils/index.js';
 import {isMethodCall} from './ast/index.js';
@@ -316,7 +316,7 @@ const create = context => {
 				const singularName = singular(node.id.name);
 				if (singularName) {
 					// Rename variable to be singularized now that it refers to a single item in the array instead of the entire array.
-					const singularizedName = avoidCapture(singularName, getScopes(scope));
+					const singularizedName = getAvailableVariableName(singularName, getScopes(scope));
 					yield * renameVariable(variable, singularizedName, fixer);
 
 					// Prevent possible variable conflicts

rules/prefer-ternary.js

@@ -1,12 +1,14 @@
 import {isParenthesized} from '@eslint-community/eslint-utils';
-import avoidCapture from './utils/avoid-capture.js';
-import needsSemicolon from './utils/needs-semicolon.js';
-import isSameReference from './utils/is-same-reference.js';
-import getIndentString from './utils/get-indent-string.js';
-import {getParenthesizedText} from './utils/parentheses.js';
-import shouldAddParenthesesToConditionalExpressionChild from './utils/should-add-parentheses-to-conditional-expression-child.js';
+import {
+	getAvailableVariableName,
+	needsSemicolon,
+	isSameReference,
+	getIndentString,
+	getParenthesizedText,
+	shouldAddParenthesesToConditionalExpressionChild,
+	getScopes,
+} from './utils/index.js';
 import {extendFixRange} from './fix/index.js';
-import getScopes from './utils/get-scopes.js';
 
 const messageId = 'prefer-ternary';
 
@@ -216,7 +218,7 @@ const create = context => {
 				let generateNewVariables = false;
 				if (type === 'ThrowStatement') {
 					const scopes = getScopes(scope);
-					const errorName = avoidCapture('error', scopes, isSafeName);
+					const errorName = getAvailableVariableName('error', scopes, isSafeName);
 
 					for (const scope of scopes) {
 						if (!scopeToNamesGeneratedByFixer.has(scope)) {

rules/prevent-abbreviations.js

@@ -1,14 +1,16 @@
 import path from 'node:path';
 import {isRegExp} from 'node:util/types';
 import {defaultsDeep, upperFirst, lowerFirst} from './utils/lodash.js';
-import avoidCapture from './utils/avoid-capture.js';
-import cartesianProductSamples from './utils/cartesian-product-samples.js';
-import isShorthandPropertyValue from './utils/is-shorthand-property-value.js';
-import isShorthandImportLocal from './utils/is-shorthand-import-local.js';
-import getVariableIdentifiers from './utils/get-variable-identifiers.js';
+import {
+	getAvailableVariableName,
+	cartesianProductSamples,
+	isShorthandPropertyValue,
+	isShorthandImportLocal,
+	getVariableIdentifiers,
+	getScopes,
+} from './utils/index.js';
 import {defaultReplacements, defaultAllowList, defaultIgnore} from './shared/abbreviations.js';
 import {renameVariable} from './fix/index.js';
-import getScopes from './utils/get-scopes.js';
 import {isStaticRequire} from './ast/index.js';
 
 const MESSAGE_ID_REPLACE = 'replace';
@@ -439,7 +441,7 @@ const create = context => {
 			variable.scope,
 		];
 		variableReplacements.samples = variableReplacements.samples.map(
-			name => avoidCapture(name, scopes, isSafeName),
+			name => getAvailableVariableName(name, scopes, isSafeName),
 		);
 
 		const problem = {

rules/utils/avoid-capture.js renamed to rules/utils/get-available-variable-name.js

@@ -112,7 +112,7 @@ Rule-specific name check function.
 
 @callback isSafe
 @param {string} name - The generated candidate name.
-@param {Scope[]} scopes - The same list of scopes you pass to `avoidCapture`.
+@param {Scope[]} scopes - The same list of scopes you pass to `getAvailableVariableName`.
 @returns {boolean} - `true` if the `name` is ok.
 */
 
@@ -130,7 +130,7 @@ Useful when you want to rename a variable (or create a new variable) while being
 @param {isSafe} [isSafe] - Rule-specific name check function.
 @returns {string} - Either `name` as is, or a string like `${name}_` suffixed with underscores to make the name unique.
 */
-export default function avoidCapture(name, scopes, isSafe = alwaysTrue) {
+export default function getAvailableVariableName(name, scopes, isSafe = alwaysTrue) {
 	if (!isValidIdentifier(name)) {
 		name += '_';
 

rules/utils/index.js

@@ -21,10 +21,12 @@ export {
 	getBooleanAncestor,
 } from './boolean.js';
 
-export {default as avoidCapture} from './avoid-capture.js';
+export {default as cartesianProductSamples} from './cartesian-product-samples.js';
 export {default as escapeString} from './escape-string.js';
+export {default as getAvailableVariableName} from './get-available-variable-name.js';
 export {default as getCallExpressionArgumentsText} from './get-call-expression-arguments-text.js';
 export {default as getCallExpressionTokens} from './get-call-expression-tokens.js';
+export {default as getIndentString} from './get-indent-string.js';
 export {default as getReferences} from './get-references.js';
 export {default as getScopes} from './get-scopes.js';
 export {default as getVariableIdentifiers} from './get-variable-identifiers.js';
@@ -39,11 +41,14 @@ export {default as isOnSameLine} from './is-on-same-line.js';
 export {default as isSameIdentifier} from './is-same-identifier.js';
 export {default as isSameReference} from './is-same-reference.js';
 export {default as isShadowed} from './is-shadowed.js';
+export {default as isShorthandImportLocal} from './is-shorthand-import-local.js';
+export {default as isShorthandPropertyValue} from './is-shorthand-property-value.js';
 export {default as isValueNotUsable} from './is-value-not-usable.js';
 export {default as needsSemicolon} from './needs-semicolon.js';
-export {default as shouldAddParenthesesToMemberExpressionObject} from './should-add-parentheses-to-member-expression-object.js';
-export {default as shouldAddParenthesesToCallExpressionCallee} from './should-add-parentheses-to-call-expression-callee.js';
 export {default as shouldAddParenthesesToAwaitExpressionArgument} from './should-add-parentheses-to-await-expression-argument.js';
+export {default as shouldAddParenthesesToCallExpressionCallee} from './should-add-parentheses-to-call-expression-callee.js';
+export {default as shouldAddParenthesesToConditionalExpressionChild} from './should-add-parentheses-to-conditional-expression-child.js';
+export {default as shouldAddParenthesesToMemberExpressionObject} from './should-add-parentheses-to-member-expression-object.js';
 export {default as singular} from './singular.js';
 export {default as toLocation} from './to-location.js';
 export {default as getAncestor} from './get-ancestor.js';