microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-05-22 22:55:36 -05:00
Code Issues Packages Projects Releases 212 Wiki Activity

use enum for RefactorTriggerReason

Browse Source
This commit is contained in:
Jesse Trinity
2020-05-13 16:53:31 -07:00
parent 53e8ed0089
commit 23f4dc9bd9
6 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/server/protocol.ts
View File

@@ -550,10 +550,8 @@ namespace ts.server.protocol {
triggerReason?: RefactorTriggerReason;
};
export type RefactorTriggerReason = RefactorInvokedReason;
export interface RefactorInvokedReason {
kind: "invoked";
export enum RefactorTriggerReason {
Invoked = "invoked"
}
/**

9
src/services/refactors/addOrRemoveBracesToArrowFunction.ts
View File

@@ -17,7 +17,8 @@ namespace ts.refactor.addOrRemoveBracesToArrowFunction {
function getAvailableActions(context: RefactorContext): readonly ApplicableRefactorInfo[] {
const { file, startPosition, triggerReason } = context;
const info = getConvertibleArrowFunctionAtPosition(file, startPosition, triggerReason);
const forImplicitRequest = triggerReason ? triggerReason === RefactorTriggerReason.Implicit : true;
const info = getConvertibleArrowFunctionAtPosition(file, startPosition, forImplicitRequest);
if (!info) return emptyArray;
return [{
@@ -38,7 +39,7 @@ namespace ts.refactor.addOrRemoveBracesToArrowFunction {
function getEditsForAction(context: RefactorContext, actionName: string): RefactorEditInfo | undefined {
const { file, startPosition } = context;
const info = getConvertibleArrowFunctionAtPosition(file, startPosition, /*triggerReason*/ { kind: "invoked" });
const info = getConvertibleArrowFunctionAtPosition(file, startPosition);
if (!info) return undefined;
const { expression, returnStatement, func } = info;
@@ -70,12 +71,12 @@ namespace ts.refactor.addOrRemoveBracesToArrowFunction {
return { renameFilename: undefined, renameLocation: undefined, edits };
}
function getConvertibleArrowFunctionAtPosition(file: SourceFile, startPosition: number, triggerReason?: RefactorTriggerReason): Info | undefined {
function getConvertibleArrowFunctionAtPosition(file: SourceFile, startPosition: number, forImplicitRequest = false): Info | undefined {
const node = getTokenAtPosition(file, startPosition);
const func = getContainingFunction(node);
// Only offer a refactor in the function body on explicit refactor requests.
if (!func || !isArrowFunction(func) || (!rangeContainsRange(func, node)
|| (rangeContainsRange(func.body, node) && triggerReason?.kind !== "invoked"))) return undefined;
|| (rangeContainsRange(func.body, node) && forImplicitRequest))) return undefined;
if (isExpression(func.body)) {
return {

11
src/services/refactors/extractSymbol.ts
View File

@@ -8,7 +8,8 @@ namespace ts.refactor.extractSymbol {
* Exported for tests.
*/
export function getAvailableActions(context: RefactorContext): readonly ApplicableRefactorInfo[] {
const rangeToExtract = getRangeToExtract(context.file, getRefactorContextSpan(context), context.triggerReason);
const forImplicitRequest = context.triggerReason ? context.triggerReason === RefactorTriggerReason.Implicit : true;
const rangeToExtract = getRangeToExtract(context.file, getRefactorContextSpan(context), forImplicitRequest);
const targetRange = rangeToExtract.targetRange;
if (targetRange === undefined) {
@@ -87,7 +88,7 @@ namespace ts.refactor.extractSymbol {
/* Exported for tests */
export function getEditsForAction(context: RefactorContext, actionName: string): RefactorEditInfo | undefined {
const rangeToExtract = getRangeToExtract(context.file, getRefactorContextSpan(context), /* triggerReason*/ { kind: "invoked" });
const rangeToExtract = getRangeToExtract(context.file, getRefactorContextSpan(context));
const targetRange = rangeToExtract.targetRange!; // TODO:GH#18217
const parsedFunctionIndexMatch = /^function_scope_(\d+)$/.exec(actionName);
@@ -186,12 +187,12 @@ namespace ts.refactor.extractSymbol {
* not shown to the user, but can be used by us diagnostically)
*/
// exported only for tests
export function getRangeToExtract(sourceFile: SourceFile, span: TextSpan, triggerReason?: RefactorTriggerReason): RangeToExtract {
export function getRangeToExtract(sourceFile: SourceFile, span: TextSpan, forImplicitRequest = false): RangeToExtract {
const { length } = span;
if (length === 0 && triggerReason?.kind !== "invoked") {
if (length === 0 && forImplicitRequest) {
return { errors: [createFileDiagnostic(sourceFile, span.start, length, Messages.cannotExtractEmpty)] };
}
const explicitCursorRequest = length === 0 && triggerReason?.kind === "invoked";
const explicitCursorRequest = length === 0 && !forImplicitRequest;
// Walk up starting from the the start position until we find a non-SourceFile node that subsumes the selected span.
// This may fail (e.g. you select two statements in the root of a source file)

9
src/services/refactors/extractType.ts
View File

@@ -6,7 +6,8 @@ namespace ts.refactor {
const extractToTypeDef = "Extract to typedef";
registerRefactor(refactorName, {
getAvailableActions(context): readonly ApplicableRefactorInfo[] {
const info = getRangeToExtract(context, context.triggerReason);
const forImplicitRequest = context.triggerReason ? context.triggerReason === RefactorTriggerReason.Implicit : true;
const info = getRangeToExtract(context, forImplicitRequest);
if (!info) return emptyArray;
return [{
@@ -23,7 +24,7 @@ namespace ts.refactor {
},
getEditsForAction(context, actionName): RefactorEditInfo {
const { file, } = context;
const info = Debug.checkDefined(getRangeToExtract(context, /*triggerReason*/ { kind: "invoked" }), "Expected to find a range to extract");
const info = Debug.checkDefined(getRangeToExtract(context), "Expected to find a range to extract");
const name = getUniqueName("NewType", file);
const edits = textChanges.ChangeTracker.with(context, changes => {
@@ -58,12 +59,12 @@ namespace ts.refactor {
type Info = TypeAliasInfo | InterfaceInfo;
function getRangeToExtract(context: RefactorContext, triggerReason?: RefactorTriggerReason): Info | undefined {
function getRangeToExtract(context: RefactorContext, forImplicitRequest = false): Info | undefined {
const { file, startPosition } = context;
const isJS = isSourceFileJS(file);
const current = getTokenAtPosition(file, startPosition);
const range = createTextRangeFromSpan(getRefactorContextSpan(context));
const explicitCursorRequest = range.pos === range.end && triggerReason?.kind === "invoked";
const explicitCursorRequest = range.pos === range.end && !forImplicitRequest;
const selection = findAncestor(current, (node => node.parent && isTypeNode(node) && !rangeContainsSkipTrivia(range, node.parent, file) &&
(explicitCursorRequest || nodeOverlapsWithStartEnd(current, file, range.pos, range.end))));

7
src/services/types.ts
View File

@@ -741,10 +741,9 @@ namespace ts {
commands?: CodeActionCommand[];
}
export type RefactorTriggerReason = RefactorInvokedReason;
export interface RefactorInvokedReason {
kind: "invoked";
export enum RefactorTriggerReason {
Implicit = "implicit",
Invoked = "invoked",
}
export interface TextInsertion {

2
src/testRunner/unittests/services/extract/ranges.ts
View File

@@ -7,7 +7,7 @@ namespace ts {
if (!selectionRange) {
throw new Error(`Test ${s} does not specify selection range`);
}
const result = refactor.extractSymbol.getRangeToExtract(file, createTextSpanFromRange(selectionRange));
const result = refactor.extractSymbol.getRangeToExtract(file, createTextSpanFromRange(selectionRange), /*forImplicitRequest*/ true);
assert(result.targetRange === undefined, "failure expected");
const sortedErrors = result.errors!.map(e => <string>e.messageText).sort();
assert.deepEqual(sortedErrors, expectedErrors.sort(), "unexpected errors");