Shrink error span on @type errors for signatures #42024
Merged
Conversation
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
Previously, the error span was too large on @type errors on functions when the type was not a function. The span covered the entire tag. This PR changes the error node just to be the type of the type tag. In other words, the error span was previously this: ``` @type {IncorrectType} ``` But is now just this: ``` IncorrectType ``` Fixes the first error from #41974, but not the other two. Co-authored-by: Ashya Manning <[email protected]> Co-authored-by: Nilber Remon <[email protected]>
typescript-bot
added
Author: Team
For Uncommitted Bug
andrewbranch
approved these changes
Dec 18, 2020
|
This error still is a little strange because it doesn't actually highlight the function declaration itself. You'd think it would switch to that with a "the signature is declared here. Still an overall improvement! I don't think that should block anything. |
|
@DanielRosenwasser I agree that's an improvement -- and this error message is specific to the |
Zzzen
pushed a commit
to Zzzen/TypeScript
that referenced
this pull request
Jan 16, 2021
Previously, the error span was too large on @type errors on functions when the type was not a function. The span covered the entire tag. This PR changes the error node just to be the type of the type tag. In other words, the error span was previously this: ``` @type {IncorrectType} ``` But is now just this: ``` IncorrectType ``` Fixes the first error from microsoft#41974, but not the other two. Co-authored-by: Ashya Manning <[email protected]> Co-authored-by: Nilber Remon <[email protected]> Co-authored-by: Ashya Manning <[email protected]> Co-authored-by: Nilber Remon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Previously, the error span was too large on @type errors on functions
when the type was not a function. The span covered the entire tag. This
PR changes the error node just to be the type of the type tag. In other words,
the error span was previously this:
But is now just this:
Fixes the first error from #41974, but not the other two.
Thanks @ashyamanning and @neuhelos!