This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
Include actual types for restrict-plus-operands. #4635
Merged
Conversation
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
|
@bowenni can you take a look at this? |
|
I think the test failure is an infrastructure failure, but I cannot retry because I don't have permissions. |
|
I love this idea! Marked as accepting PRs. In the future @mprobst, please file an issue describing your requested changes before sending a PR that non-trivially changes TSLint. This one happens to be immediately acceptable but most aren't. |
JoshuaKGoldberg
suggested changes
Apr 7, 2019
It can be difficult for users to find out why exactly they received the
"restrict-plus-operands" lint error. In particular, users often end up
with `any` types leaking into their code (e.g. in tests), and are then
puzzled why this triggers.
To fix, this change includes a textual representation of the type in the
error message, e.g.:
[Operands of '+' operation must either be both strings or both numbers, but found 5 + undefined[]]
The type representation isn't always super pretty (e.g. the
`undefined[]` bit above), but should still be helpful, and also matches
TS compiler's representation of these.
Will do. |
JoshuaKGoldberg
approved these changes
Apr 7, 2019
adidahiya
approved these changes
Apr 16, 2019
There was a problem hiding this comment.
thanks @mprobst @JoshuaKGoldberg! I'll fix the build on master if it fails there.
This was referenced Mar 18, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
It can be difficult for users to find out why exactly they received the
"restrict-plus-operands" lint error. In particular, users often end up
with
anytypes leaking into their code (e.g. in tests), and are thenpuzzled why this triggers.
To fix, this change includes a textual representation of the type in the
error message, e.g.:
The type representation isn't always super pretty (e.g. the
undefined[]bit above), but should still be helpful, and also matchesTS compiler's representation of these.
PR checklist
CHANGELOG.md entry:
[enhancement] Improve error message for
restrict-plus-operandsrule.