Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
fix(eslint-plugin): [no-unsafe-type-assertion] fix for unsafe assertion to a constrained type parameter#10461
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
JoshuaKGoldberg merged 15 commits intotypescript-eslint:mainfromcontroversial:unsafe-constrained-type-assertionDec 21, 2024
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
15 commits Select commitHold shift + click to select a range
7529400 Add failing test case for unsafe type assertion with constrained gene…
controversial9117da0 Use actual type instead of “constrained type” for no-unsafe-type-asse…
controversialece33d8 tweak test cases
controversial354dc32 Custom error message for “assignable to the constraint” case
controversial05bdf78 rename “assignable to the constraint” error message
controversial3578532 spelling
controversiala1cf417 tweak message
controversiald7a7600 Add new test cases from @kirkwaiblinger
controversial60cba85 Move isAssignableToConstraint check into isAssertionSafe
controversiale560ef3 Properly handle unconstrained type parameters, including new error me…
controversialc39c4b7 distinguish between “parameter extends other parameter” and “paramete…
controversial3c60099 Merge branch 'main' into unsafe-constrained-type-assertion
controversial7719c45 Merge branch 'main' into unsafe-constrained-type-assertion
controversial504df89 clean up extra pieces in unit tests
controversial239f3df test lines
kirkwaiblingerFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
71 changes: 52 additions & 19 deletionspackages/eslint-plugin/src/rules/no-unsafe-type-assertion.ts
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 |
|---|---|---|
| @@ -5,7 +5,6 @@ import * as ts from 'typescript'; | ||
| import { | ||
| createRule, | ||
| getParserServices, | ||
| isTypeAnyType, | ||
| isTypeUnknownType, | ||
| @@ -25,8 +24,12 @@ export default createRule({ | ||
| 'Unsafe assertion from {{type}} detected: consider using type guards or a safer assertion.', | ||
| unsafeToAnyTypeAssertion: | ||
| 'Unsafe assertion to {{type}} detected: consider using a more specific type to ensure safety.', | ||
| unsafeToUnconstrainedTypeAssertion: | ||
| "Unsafe type assertion: '{{type}}' could be instantiated with an arbitrary type which could be unrelated to the original type.", | ||
| unsafeTypeAssertion: | ||
| "Unsafe type assertion: type '{{type}}' is more narrow than the original type.", | ||
| unsafeTypeAssertionAssignableToConstraint: | ||
| "Unsafe type assertion: the original type is assignable to the constraint of type '{{type}}', but '{{type}}' could be instantiated with a different subtype of its constraint.", | ||
| }, | ||
| schema: [], | ||
| }, | ||
| @@ -49,14 +52,8 @@ export default createRule({ | ||
| function checkExpression( | ||
| node: TSESTree.TSAsExpression | TSESTree.TSTypeAssertion, | ||
| ): void { | ||
| const expressionType = services.getTypeAtLocation(node.expression); | ||
| const assertedType = services.getTypeAtLocation(node.typeAnnotation); | ||
| if (expressionType === assertedType) { | ||
| return; | ||
| @@ -115,24 +112,60 @@ export default createRule({ | ||
| // Use the widened type in case of an object literal so `isTypeAssignableTo()` | ||
| // won't fail on excess property check. | ||
| constexpressionWidenedType = isObjectLiteralType(expressionType) | ||
controversial marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| ? checker.getWidenedType(expressionType) | ||
| : expressionType; | ||
| const isAssertionSafe = checker.isTypeAssignableTo( | ||
| expressionWidenedType, | ||
| assertedType, | ||
| ); | ||
| if (isAssertionSafe) { | ||
| return; | ||
| } | ||
| // Produce a more specific error message when targeting a type parameter | ||
| if (tsutils.isTypeParameter(assertedType)) { | ||
| const assertedTypeConstraint = | ||
| checker.getBaseConstraintOfType(assertedType); | ||
| if (!assertedTypeConstraint) { | ||
| // asserting to an unconstrained type parameter is unsafe | ||
| context.report({ | ||
| node, | ||
| messageId: 'unsafeToUnconstrainedTypeAssertion', | ||
| data: { | ||
| type: checker.typeToString(assertedType), | ||
| }, | ||
| }); | ||
| return; | ||
| } | ||
| // special case message if the original type is assignable to the | ||
| // constraint of the target type parameter | ||
| const isAssignableToConstraint = checker.isTypeAssignableTo( | ||
| expressionWidenedType, | ||
| assertedTypeConstraint, | ||
| ); | ||
| if (isAssignableToConstraint) { | ||
| context.report({ | ||
| node, | ||
| messageId: 'unsafeTypeAssertionAssignableToConstraint', | ||
| data: { | ||
| type: checker.typeToString(assertedType), | ||
| }, | ||
| }); | ||
| return; | ||
| } | ||
| } | ||
| // General error message | ||
| context.report({ | ||
| node, | ||
| messageId: 'unsafeTypeAssertion', | ||
| data: { | ||
| type: checker.typeToString(assertedType), | ||
| }, | ||
| }); | ||
| } | ||
| return { | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.