Skip to content

Commit ed014db

Browse files
Add names for refactoring functions. (#47375)
* Add names for refactoring functions. * Consistency in function names.
1 parent faee7b3 commit ed014db

14 files changed

+45
-44
lines changed

src/services/refactors/addOrRemoveBracesToArrowFunction.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ namespace ts.refactor.addOrRemoveBracesToArrowFunction {
1515
};
1616
registerRefactor(refactorName, {
1717
kinds: [removeBracesAction.kind],
18-
getEditsForAction,
19-
getAvailableActions });
18+
getEditsForAction: getRefactorEditsToRemoveFunctionBraces,
19+
getAvailableActions: getRefactorActionsToRemoveFunctionBraces
20+
});
2021

2122
interface FunctionBracesInfo {
2223
func: ArrowFunction;
@@ -25,7 +26,7 @@ namespace ts.refactor.addOrRemoveBracesToArrowFunction {
2526
addBraces: boolean;
2627
}
2728

28-
function getAvailableActions(context: RefactorContext): readonly ApplicableRefactorInfo[] {
29+
function getRefactorActionsToRemoveFunctionBraces(context: RefactorContext): readonly ApplicableRefactorInfo[] {
2930
const { file, startPosition, triggerReason } = context;
3031
const info = getConvertibleArrowFunctionAtPosition(file, startPosition, triggerReason === "invoked");
3132
if (!info) return emptyArray;
@@ -54,7 +55,7 @@ namespace ts.refactor.addOrRemoveBracesToArrowFunction {
5455
return emptyArray;
5556
}
5657

57-
function getEditsForAction(context: RefactorContext, actionName: string): RefactorEditInfo | undefined {
58+
function getRefactorEditsToRemoveFunctionBraces(context: RefactorContext, actionName: string): RefactorEditInfo | undefined {
5859
const { file, startPosition } = context;
5960
const info = getConvertibleArrowFunctionAtPosition(file, startPosition);
6061
Debug.assert(info && !isRefactorErrorInfo(info), "Expected applicable refactor info");

src/services/refactors/convertArrowFunctionOrFunctionExpression.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ namespace ts.refactor.convertArrowFunctionOrFunctionExpression {
2424
toNamedFunctionAction.kind,
2525
toArrowFunctionAction.kind
2626
],
27-
getEditsForAction,
28-
getAvailableActions
27+
getEditsForAction: getRefactorEditsToConvertFunctionExpressions,
28+
getAvailableActions: getRefactorActionsToConvertFunctionExpressions
2929
});
3030

3131
interface FunctionInfo {
@@ -40,7 +40,7 @@ namespace ts.refactor.convertArrowFunctionOrFunctionExpression {
4040
readonly name: Identifier;
4141
}
4242

43-
function getAvailableActions(context: RefactorContext): readonly ApplicableRefactorInfo[] {
43+
function getRefactorActionsToConvertFunctionExpressions(context: RefactorContext): readonly ApplicableRefactorInfo[] {
4444
const { file, startPosition, program, kind } = context;
4545
const info = getFunctionInfo(file, startPosition, program);
4646

@@ -88,7 +88,7 @@ namespace ts.refactor.convertArrowFunctionOrFunctionExpression {
8888
}];
8989
}
9090

91-
function getEditsForAction(context: RefactorContext, actionName: string): RefactorEditInfo | undefined {
91+
function getRefactorEditsToConvertFunctionExpressions(context: RefactorContext, actionName: string): RefactorEditInfo | undefined {
9292
const { file, startPosition, program } = context;
9393
const info = getFunctionInfo(file, startPosition, program);
9494

src/services/refactors/convertExport.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ namespace ts.refactor {
1818
defaultToNamedAction.kind,
1919
namedToDefaultAction.kind
2020
],
21-
getAvailableActions(context): readonly ApplicableRefactorInfo[] {
21+
getAvailableActions: function getRefactorActionsToConvertBetweenNamedAndDefaultExports(context): readonly ApplicableRefactorInfo[] {
2222
const info = getInfo(context, context.triggerReason === "invoked");
2323
if (!info) return emptyArray;
2424

@@ -38,7 +38,7 @@ namespace ts.refactor {
3838

3939
return emptyArray;
4040
},
41-
getEditsForAction(context, actionName): RefactorEditInfo {
41+
getEditsForAction: function getRefactorEditsToConvertBetweenNamedAndDefaultExports(context, actionName): RefactorEditInfo {
4242
Debug.assert(actionName === defaultToNamedAction.name || actionName === namedToDefaultAction.name, "Unexpected action name");
4343
const info = getInfo(context);
4444
Debug.assert(info && !isRefactorErrorInfo(info), "Expected applicable refactor info");

src/services/refactors/convertImport.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ namespace ts.refactor {
1818
namespaceToNamedAction.kind,
1919
namedToNamespaceAction.kind
2020
],
21-
getAvailableActions(context): readonly ApplicableRefactorInfo[] {
21+
getAvailableActions: function getRefactorActionsToConvertBetweenNamedAndNamespacedImports(context): readonly ApplicableRefactorInfo[] {
2222
const info = getImportToConvert(context, context.triggerReason === "invoked");
2323
if (!info) return emptyArray;
2424

@@ -39,7 +39,7 @@ namespace ts.refactor {
3939

4040
return emptyArray;
4141
},
42-
getEditsForAction(context, actionName): RefactorEditInfo {
42+
getEditsForAction: function getRefactorEditsToConvertBetweenNamedAndNamespacedImports(context, actionName): RefactorEditInfo {
4343
Debug.assert(actionName === namespaceToNamedAction.name || actionName === namedToNamespaceAction.name, "Unexpected action name");
4444
const info = getImportToConvert(context);
4545
Debug.assert(info && !isRefactorErrorInfo(info), "Expected applicable refactor info");

src/services/refactors/convertOverloadListToSingleSignature.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ namespace ts.refactor.addOrRemoveBracesToArrowFunction {
1010
};
1111
registerRefactor(refactorName, {
1212
kinds: [functionOverloadAction.kind],
13-
getEditsForAction,
14-
getAvailableActions
13+
getEditsForAction: getRefactorEditsToConvertOverloadsToOneSignature,
14+
getAvailableActions: getRefactorActionsToConvertOverloadsToOneSignature
1515
});
1616

17-
function getAvailableActions(context: RefactorContext): readonly ApplicableRefactorInfo[] {
17+
function getRefactorActionsToConvertOverloadsToOneSignature(context: RefactorContext): readonly ApplicableRefactorInfo[] {
1818
const { file, startPosition, program } = context;
1919
const info = getConvertableOverloadListAtPosition(file, startPosition, program);
2020
if (!info) return emptyArray;
@@ -26,7 +26,7 @@ namespace ts.refactor.addOrRemoveBracesToArrowFunction {
2626
}];
2727
}
2828

29-
function getEditsForAction(context: RefactorContext): RefactorEditInfo | undefined {
29+
function getRefactorEditsToConvertOverloadsToOneSignature(context: RefactorContext): RefactorEditInfo | undefined {
3030
const { file, startPosition, program } = context;
3131
const signatureDecls = getConvertableOverloadListAtPosition(file, startPosition, program);
3232
if (!signatureDecls) return undefined;

src/services/refactors/convertParamsToDestructuredObject.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ namespace ts.refactor.convertParamsToDestructuredObject {
1111
};
1212
registerRefactor(refactorName, {
1313
kinds: [toDestructuredAction.kind],
14-
getEditsForAction,
15-
getAvailableActions
14+
getEditsForAction: getRefactorEditsToConvertParametersToDestructuredObject,
15+
getAvailableActions: getRefactorActionsToConvertParametersToDestructuredObject
1616
});
1717

18-
function getAvailableActions(context: RefactorContext): readonly ApplicableRefactorInfo[] {
18+
function getRefactorActionsToConvertParametersToDestructuredObject(context: RefactorContext): readonly ApplicableRefactorInfo[] {
1919
const { file, startPosition } = context;
2020
const isJSFile = isSourceFileJS(file);
2121
if (isJSFile) return emptyArray; // TODO: GH#30113
@@ -29,7 +29,7 @@ namespace ts.refactor.convertParamsToDestructuredObject {
2929
}];
3030
}
3131

32-
function getEditsForAction(context: RefactorContext, actionName: string): RefactorEditInfo | undefined {
32+
function getRefactorEditsToConvertParametersToDestructuredObject(context: RefactorContext, actionName: string): RefactorEditInfo | undefined {
3333
Debug.assert(actionName === refactorName, "Unexpected action name");
3434
const { file, startPosition, program, cancellationToken, host } = context;
3535
const functionDeclaration = getFunctionDeclarationAtPosition(file, startPosition, program.getTypeChecker());

src/services/refactors/convertStringOrTemplateLiteral.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ namespace ts.refactor.convertStringOrTemplateLiteral {
1010
};
1111
registerRefactor(refactorName, {
1212
kinds: [convertStringAction.kind],
13-
getEditsForAction,
14-
getAvailableActions
13+
getEditsForAction: getRefactorEditsToConvertToTemplateString,
14+
getAvailableActions: getRefactorActionsToConvertToTemplateString
1515
});
1616

17-
function getAvailableActions(context: RefactorContext): readonly ApplicableRefactorInfo[] {
17+
function getRefactorActionsToConvertToTemplateString(context: RefactorContext): readonly ApplicableRefactorInfo[] {
1818
const { file, startPosition } = context;
1919
const node = getNodeOrParentOfParentheses(file, startPosition);
2020
const maybeBinary = getParentBinaryExpression(node);
@@ -48,7 +48,7 @@ namespace ts.refactor.convertStringOrTemplateLiteral {
4848
return node;
4949
}
5050

51-
function getEditsForAction(context: RefactorContext, actionName: string): RefactorEditInfo | undefined {
51+
function getRefactorEditsToConvertToTemplateString(context: RefactorContext, actionName: string): RefactorEditInfo | undefined {
5252
const { file, startPosition } = context;
5353
const node = getNodeOrParentOfParentheses(file, startPosition);
5454

src/services/refactors/convertToOptionalChainExpression.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ namespace ts.refactor.convertToOptionalChainExpression {
1010
};
1111
registerRefactor(refactorName, {
1212
kinds: [toOptionalChainAction.kind],
13-
getAvailableActions,
14-
getEditsForAction
13+
getEditsForAction: getRefactorEditsToConvertToOptionalChain,
14+
getAvailableActions: getRefactorActionsToConvertToOptionalChain,
1515
});
1616

17-
function getAvailableActions(context: RefactorContext): readonly ApplicableRefactorInfo[] {
17+
function getRefactorActionsToConvertToOptionalChain(context: RefactorContext): readonly ApplicableRefactorInfo[] {
1818
const info = getInfo(context, context.triggerReason === "invoked");
1919
if (!info) return emptyArray;
2020

@@ -36,7 +36,7 @@ namespace ts.refactor.convertToOptionalChainExpression {
3636
return emptyArray;
3737
}
3838

39-
function getEditsForAction(context: RefactorContext, actionName: string): RefactorEditInfo | undefined {
39+
function getRefactorEditsToConvertToOptionalChain(context: RefactorContext, actionName: string): RefactorEditInfo | undefined {
4040
const info = getInfo(context);
4141
Debug.assert(info && !isRefactorErrorInfo(info), "Expected applicable refactor info");
4242
const edits = textChanges.ChangeTracker.with(context, t =>

src/services/refactors/extractSymbol.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ namespace ts.refactor.extractSymbol {
1717
extractConstantAction.kind,
1818
extractFunctionAction.kind
1919
],
20-
getAvailableActions,
21-
getEditsForAction
20+
getEditsForAction: getRefactorEditsToExtractSymbol,
21+
getAvailableActions: getRefactorActionsToExtractSymbol,
2222
});
2323

2424
/**
2525
* Compute the associated code actions
2626
* Exported for tests.
2727
*/
28-
export function getAvailableActions(context: RefactorContext): readonly ApplicableRefactorInfo[] {
28+
export function getRefactorActionsToExtractSymbol(context: RefactorContext): readonly ApplicableRefactorInfo[] {
2929
const requestedRefactor = context.kind;
3030
const rangeToExtract = getRangeToExtract(context.file, getRefactorContextSpan(context), context.triggerReason === "invoked");
3131
const targetRange = rangeToExtract.targetRange;
@@ -168,7 +168,7 @@ namespace ts.refactor.extractSymbol {
168168
}
169169

170170
/* Exported for tests */
171-
export function getEditsForAction(context: RefactorContext, actionName: string): RefactorEditInfo | undefined {
171+
export function getRefactorEditsToExtractSymbol(context: RefactorContext, actionName: string): RefactorEditInfo | undefined {
172172
const rangeToExtract = getRangeToExtract(context.file, getRefactorContextSpan(context));
173173
const targetRange = rangeToExtract.targetRange!; // TODO:GH#18217
174174

src/services/refactors/extractType.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ namespace ts.refactor {
2424
extractToInterfaceAction.kind,
2525
extractToTypeDefAction.kind
2626
],
27-
getAvailableActions(context): readonly ApplicableRefactorInfo[] {
27+
getAvailableActions: function getRefactorActionsToExtractType(context): readonly ApplicableRefactorInfo[] {
2828
const info = getRangeToExtract(context, context.triggerReason === "invoked");
2929
if (!info) return emptyArray;
3030

@@ -51,7 +51,7 @@ namespace ts.refactor {
5151

5252
return emptyArray;
5353
},
54-
getEditsForAction(context, actionName): RefactorEditInfo {
54+
getEditsForAction: function getRefactorEditsToExtractType(context, actionName): RefactorEditInfo {
5555
const { file, } = context;
5656
const info = getRangeToExtract(context);
5757
Debug.assert(info && !isRefactorErrorInfo(info), "Expected to find a range to extract");

src/services/refactors/generateGetAccessorAndSetAccessor.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ namespace ts.refactor.generateGetAccessorAndSetAccessor {
1010
};
1111
registerRefactor(actionName, {
1212
kinds: [generateGetSetAction.kind],
13-
getEditsForAction(context, actionName) {
13+
getEditsForAction: function getRefactorActionsToGenerateGetAndSetAccessors(context, actionName) {
1414
if (!context.endPosition) return undefined;
1515
const info = codefix.getAccessorConvertiblePropertyAtPosition(context.file, context.program, context.startPosition, context.endPosition);
1616
Debug.assert(info && !isRefactorErrorInfo(info), "Expected applicable refactor info");

src/services/refactors/inferFunctionReturnType.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ namespace ts.refactor.inferFunctionReturnType {
1010
};
1111
registerRefactor(refactorName, {
1212
kinds: [inferReturnTypeAction.kind],
13-
getEditsForAction,
14-
getAvailableActions
13+
getEditsForAction: getRefactorEditsToInferReturnType,
14+
getAvailableActions: getRefactorActionsToInferReturnType
1515
});
1616

17-
function getEditsForAction(context: RefactorContext): RefactorEditInfo | undefined {
17+
function getRefactorEditsToInferReturnType(context: RefactorContext): RefactorEditInfo | undefined {
1818
const info = getInfo(context);
1919
if (info && !isRefactorErrorInfo(info)) {
2020
const edits = textChanges.ChangeTracker.with(context, t => doChange(context.file, t, info.declaration, info.returnTypeNode));
@@ -23,7 +23,7 @@ namespace ts.refactor.inferFunctionReturnType {
2323
return undefined;
2424
}
2525

26-
function getAvailableActions(context: RefactorContext): readonly ApplicableRefactorInfo[] {
26+
function getRefactorActionsToInferReturnType(context: RefactorContext): readonly ApplicableRefactorInfo[] {
2727
const info = getInfo(context);
2828
if (!info) return emptyArray;
2929
if (!isRefactorErrorInfo(info)) {

src/services/refactors/moveToNewFile.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ namespace ts.refactor {
1010
};
1111
registerRefactor(refactorName, {
1212
kinds: [moveToNewFileAction.kind],
13-
getAvailableActions(context): readonly ApplicableRefactorInfo[] {
13+
getAvailableActions: function getRefactorActionsToMoveToNewFile(context): readonly ApplicableRefactorInfo[] {
1414
const statements = getStatementsToMove(context);
1515
if (context.preferences.allowTextChangesInNewFiles && statements) {
1616
return [{ name: refactorName, description, actions: [moveToNewFileAction] }];
@@ -22,7 +22,7 @@ namespace ts.refactor {
2222
}
2323
return emptyArray;
2424
},
25-
getEditsForAction(context, actionName): RefactorEditInfo {
25+
getEditsForAction: function getRefactorEditsToMoveToNewFile(context, actionName): RefactorEditInfo {
2626
Debug.assert(actionName === refactorName, "Wrong refactor invoked");
2727
const statements = Debug.checkDefined(getStatementsToMove(context));
2828
const edits = textChanges.ChangeTracker.with(context, t => doChange(context.file, context.program, statements, t, context.host, context.preferences));

src/testRunner/unittests/services/extract/helpers.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,14 +107,14 @@ namespace ts {
107107
};
108108
const rangeToExtract = refactor.extractSymbol.getRangeToExtract(sourceFile, createTextSpanFromRange(selectionRange));
109109
assert.equal(rangeToExtract.errors, undefined, rangeToExtract.errors && "Range error: " + rangeToExtract.errors[0].messageText);
110-
const infos = refactor.extractSymbol.getAvailableActions(context);
110+
const infos = refactor.extractSymbol.getRefactorActionsToExtractSymbol(context);
111111
const actions = find(infos, info => info.description === description.message)!.actions;
112112

113113
const data: string[] = [];
114114
data.push(`// ==ORIGINAL==`);
115115
data.push(text.replace("[#|", "/*[#|*/").replace("|]", "/*|]*/"));
116116
for (const action of actions) {
117-
const { renameLocation, edits } = refactor.extractSymbol.getEditsForAction(context, action.name)!;
117+
const { renameLocation, edits } = refactor.extractSymbol.getRefactorEditsToExtractSymbol(context, action.name)!;
118118
assert.lengthOf(edits, 1);
119119
data.push(`// ==SCOPE::${action.description}==`);
120120
const newText = textChanges.applyChanges(sourceFile.text, edits[0].textChanges);
@@ -170,7 +170,7 @@ namespace ts {
170170
};
171171
const rangeToExtract = refactor.extractSymbol.getRangeToExtract(sourceFile, createTextSpanFromRange(selectionRange));
172172
assert.isUndefined(rangeToExtract.errors, rangeToExtract.errors && "Range error: " + rangeToExtract.errors[0].messageText);
173-
const infos = refactor.extractSymbol.getAvailableActions(context);
173+
const infos = refactor.extractSymbol.getRefactorActionsToExtractSymbol(context);
174174
assert.isUndefined(find(infos, info => info.description === description.message));
175175
});
176176
}

0 commit comments

Comments
 (0)