Add elaboration & quickfix for async-able arrow function #36342
+171
−0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| /* @internal */ | ||
| namespace ts.codefix { | ||
| type ContextualTrackChangesFunction = (cb: (changeTracker: textChanges.ChangeTracker) => void) => FileTextChanges[]; | ||
| const fixId = "addMissingAsync"; | ||
| const errorCodes = [ | ||
| Diagnostics.Argument_of_type_0_is_not_assignable_to_parameter_of_type_1.code, | ||
| Diagnostics.Type_0_is_not_assignable_to_type_1.code, | ||
| Diagnostics.Type_0_is_not_comparable_to_type_1.code | ||
| ]; | ||
|
|
||
| registerCodeFix({ | ||
| fixIds: [fixId], | ||
| errorCodes, | ||
| getCodeActions: context => { | ||
| const { sourceFile, errorCode, cancellationToken, program, span } = context; | ||
| const diagnostic = find(program.getDiagnosticsProducingTypeChecker().getDiagnostics(sourceFile, cancellationToken), getIsMatchingAsyncError(span, errorCode)); | ||
| const directSpan = diagnostic && diagnostic.relatedInformation && find(diagnostic.relatedInformation, r => r.code === Diagnostics.Did_you_mean_to_mark_this_function_as_async.code) as TextSpan | undefined; | ||
|
|
||
| const decl = getFixableErrorSpanDeclaration(sourceFile, directSpan); | ||
| if (!decl) { | ||
| return; | ||
| } | ||
|
|
||
| const trackChanges: ContextualTrackChangesFunction = cb => textChanges.ChangeTracker.with(context, cb); | ||
| return [getFix(context, decl, trackChanges)]; | ||
| }, | ||
| getAllCodeActions: context => { | ||
| const { sourceFile } = context; | ||
| const fixedDeclarations = createMap<true>(); | ||
| return codeFixAll(context, errorCodes, (t, diagnostic) => { | ||
| const span = diagnostic.relatedInformation && find(diagnostic.relatedInformation, r => r.code === Diagnostics.Did_you_mean_to_mark_this_function_as_async.code) as TextSpan | undefined; | ||
| const decl = getFixableErrorSpanDeclaration(sourceFile, span); | ||
| if (!decl) { | ||
| return; | ||
| } | ||
| const trackChanges: ContextualTrackChangesFunction = cb => (cb(t), []); | ||
| return getFix(context, decl, trackChanges, fixedDeclarations); | ||
| }); | ||
| }, | ||
| }); | ||
|
|
||
| type FixableDeclaration = ArrowFunction | FunctionDeclaration | FunctionExpression | MethodDeclaration; | ||
| function getFix(context: CodeFixContext | CodeFixAllContext, decl: FixableDeclaration, trackChanges: ContextualTrackChangesFunction, fixedDeclarations?: Map<true>) { | ||
| const changes = trackChanges(t => makeChange(t, context.sourceFile, decl, fixedDeclarations)); | ||
| return createCodeFixAction(fixId, changes, Diagnostics.Add_async_modifier_to_containing_function, fixId, Diagnostics.Add_all_missing_async_modifiers); | ||
| } | ||
|
|
||
| function makeChange(changeTracker: textChanges.ChangeTracker, sourceFile: SourceFile, insertionSite: FixableDeclaration, fixedDeclarations?: Map<true>) { | ||
| if (fixedDeclarations) { | ||
| if (fixedDeclarations.has(getNodeId(insertionSite).toString())) { | ||
| return; | ||
| } | ||
| } | ||
| fixedDeclarations?.set(getNodeId(insertionSite).toString(), true); | ||
| const cloneWithModifier = getSynthesizedDeepClone(insertionSite, /*includeTrivia*/ true); | ||
| cloneWithModifier.modifiers = createNodeArray(createModifiersFromModifierFlags(getModifierFlags(insertionSite) | ModifierFlags.Async)); | ||
| cloneWithModifier.modifierFlagsCache = 0; | ||
| changeTracker.replaceNode( | ||
| sourceFile, | ||
| insertionSite, | ||
| cloneWithModifier); | ||
| } | ||
|
|
||
| function getFixableErrorSpanDeclaration(sourceFile: SourceFile, span: TextSpan | undefined): FixableDeclaration | undefined { | ||
| if (!span) return undefined; | ||
| const token = getTokenAtPosition(sourceFile, span.start); | ||
| // Checker has already done work to determine that async might be possible, and has attached | ||
| // related info to the node, so start by finding the signature that exactly matches up | ||
| // with the diagnostic range. | ||
| const decl = findAncestor(token, node => { | ||
| if (node.getStart(sourceFile) < span.start || node.getEnd() > textSpanEnd(span)) { | ||
| return "quit"; | ||
| } | ||
| return (isArrowFunction(node) || isMethodDeclaration(node) || isFunctionExpression(node) || isFunctionDeclaration(node)) && textSpansEqual(span, createTextSpanFromNode(node, sourceFile)); | ||
| }) as FixableDeclaration | undefined; | ||
|
|
||
| return decl; | ||
| } | ||
|
|
||
| function getIsMatchingAsyncError(span: TextSpan, errorCode: number) { | ||
| return ({ start, length, relatedInformation, code }: Diagnostic) => | ||
| isNumber(start) && isNumber(length) && textSpansEqual({ start, length }, span) && | ||
| code === errorCode && | ||
| !!relatedInformation && | ||
| some(relatedInformation, related => related.code === Diagnostics.Did_you_mean_to_mark_this_function_as_async.code); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| /// <reference path="fourslash.ts" /> | ||
| ////interface Stuff { | ||
| //// b: () => Promise<string>; | ||
| ////} | ||
| //// | ||
| ////function foo(): Stuff | Date { | ||
| //// return { | ||
| //// b: () => "hello", | ||
| //// } | ||
| ////} | ||
|
|
||
| verify.codeFix({ | ||
| description: ts.Diagnostics.Add_async_modifier_to_containing_function.message, | ||
| index: 0, | ||
| newFileContent: | ||
| `interface Stuff { | ||
| b: () => Promise<string>; | ||
| } | ||
|
|
||
| function foo(): Stuff | Date { | ||
| return { | ||
| b: async () => "hello", | ||
| } | ||
| }` | ||
| }); | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| /// <reference path="fourslash.ts" /> | ||
| ////interface Stuff { | ||
| //// b: () => Promise<string>; | ||
| ////} | ||
| //// | ||
| ////function foo(): Stuff | Date { | ||
| //// return { | ||
| //// b: _ => "hello", | ||
| //// } | ||
| ////} | ||
|
|
||
| verify.codeFix({ | ||
| description: ts.Diagnostics.Add_async_modifier_to_containing_function.message, | ||
| index: 0, | ||
| newFileContent: | ||
| `interface Stuff { | ||
| b: () => Promise<string>; | ||
| } | ||
|
|
||
| function foo(): Stuff | Date { | ||
| return { | ||
| b: async (_) => "hello", | ||
| } | ||
| }` | ||
| }); | ||
|
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can this code be shared with
isMissingAwaitErrorinaddMissingAwait.ts? It seems like finding a diagnostic with particular related information might be a general utility.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not quite! In the other quick fix, we're checking if the diagnostic's span matches the input span, then returning the diagnostic if it matches and has the target related span code. In this quick fix, we don't do the filtering on related span at the matching step, because we're looking to
findthe span of the related span (so we can use that instead). So, yes, there's a common iteration bit, but to handle the bits variable between the two is essentially just asomewith variable condition, onto which we then append an optional extra filter/map on the final result. Which seems like a bit too multifunctional for a single helper for my tastes.But it should totally feel similar, since I started writing this quick fix by copying the
addMissingAwaitquick fix, which is why the span-matching check is almost identical in structure.