-
Notifications
You must be signed in to change notification settings - Fork 12.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add 'Remove unnecessary await' suggestion and fix #32363
Merged
andrewbranch
merged 7 commits into
microsoft:master
from
andrewbranch:enhancement/unnecessary-await
Jul 12, 2019
+97
−5
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
e752f70
Add remove unnecessary await fix
andrewbranch 38247e0
Add test for removing unnecessary parens after await is gone
andrewbranch e0a781e
Fix handling of numbers in property access expressions
andrewbranch 58d960e
Don’t offer suggestion when awaited type is any/unknown
andrewbranch a54ed2d
Fix random other test
andrewbranch e27d260
Fix new expression edge cases
andrewbranch f22dc9d
Only remove parens for identifiers and call expressions
andrewbranch File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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 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 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,33 @@ | ||
/* @internal */ | ||
namespace ts.codefix { | ||
const fixId = "removeUnnecessaryAwait"; | ||
const errorCodes = [ | ||
Diagnostics.await_has_no_effect_on_the_type_of_this_expression.code, | ||
]; | ||
|
||
registerCodeFix({ | ||
errorCodes, | ||
getCodeActions: (context) => { | ||
const changes = textChanges.ChangeTracker.with(context, t => makeChange(t, context.sourceFile, context.span)); | ||
if (changes.length > 0) { | ||
return [createCodeFixAction(fixId, changes, Diagnostics.Remove_unnecessary_await, fixId, Diagnostics.Remove_all_unnecessary_uses_of_await)]; | ||
} | ||
}, | ||
fixIds: [fixId], | ||
getAllCodeActions: context => { | ||
return codeFixAll(context, errorCodes, (changes, diag) => makeChange(changes, diag.file, diag)); | ||
}, | ||
}); | ||
|
||
function makeChange(changeTracker: textChanges.ChangeTracker, sourceFile: SourceFile, span: TextSpan) { | ||
const awaitKeyword = tryCast(getTokenAtPosition(sourceFile, span.start), (node): node is AwaitKeywordToken => node.kind === SyntaxKind.AwaitKeyword); | ||
const awaitExpression = awaitKeyword && tryCast(awaitKeyword.parent, isAwaitExpression); | ||
if (!awaitExpression) { | ||
return; | ||
} | ||
|
||
const parenthesizedExpression = tryCast(awaitExpression.parent, isParenthesizedExpression); | ||
const removeParens = parenthesizedExpression && (isIdentifier(awaitExpression.expression) || isCallExpression(awaitExpression.expression)); | ||
changeTracker.replaceNode(sourceFile, removeParens ? parenthesizedExpression || awaitExpression : awaitExpression, awaitExpression.expression); | ||
} | ||
} |
This file contains 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 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,40 @@ | ||
/// <reference path="fourslash.ts" /> | ||
////declare class C { foo(): void } | ||
////declare function foo(): string; | ||
////async function f() { | ||
//// await ""; | ||
//// await 0; | ||
//// (await foo()).toLowerCase(); | ||
//// (await 0).toFixed(); | ||
//// (await new C).foo(); | ||
////} | ||
|
||
verify.codeFix({ | ||
description: ts.Diagnostics.Remove_unnecessary_await.message, | ||
index: 0, | ||
newFileContent: | ||
`declare class C { foo(): void } | ||
declare function foo(): string; | ||
async function f() { | ||
""; | ||
await 0; | ||
(await foo()).toLowerCase(); | ||
(await 0).toFixed(); | ||
(await new C).foo(); | ||
}` | ||
}); | ||
|
||
verify.codeFixAll({ | ||
fixAllDescription: ts.Diagnostics.Remove_all_unnecessary_uses_of_await.message, | ||
fixId: "removeUnnecessaryAwait", | ||
newFileContent: | ||
`declare class C { foo(): void } | ||
declare function foo(): string; | ||
async function f() { | ||
""; | ||
0; | ||
foo().toLowerCase(); | ||
(0).toFixed(); | ||
(new C).foo(); | ||
}` | ||
}); |
This file contains 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
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.
@andrewbranch it seems you dropped the code necessary to avoid changing the parsing of NewExpression.
However, there's a whole category of exceptions that's not handled here: if the parenthesized AwaitExpression is at the start of the statement, the fixed code could parse as declaration instead of expression:
These cases are already handled in factory.ts, see the uses of
getLeftmostExpression