checkJs: require JSDoc type argument for Array, Object, and Promise in noImplicitAny #32829
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
|
|
5 tasks
brendankenny
commented
Aug 13, 2019
| @@ -9348,7 +9348,7 @@ namespace ts { | |||
| return anyType; | |||
| } | |||
| checkNoTypeArguments(node); | |||
| return anyType; | |||
| return !noImplicitAny ? anyType : undefined; | |||
There was a problem hiding this comment.
these were the minimal change, but they could be negated or split up if that seems clearer
sandersn
approved these changes
Aug 16, 2019
|
I think changing Object to Object is what people want when writing fresh jsdoc for Typescript's consumption. And there don't seem to be many people to break anyway. |
timsuchanek
pushed a commit
to timsuchanek/TypeScript
that referenced
this pull request
Sep 11, 2019
…n noImplicitAny (microsoft#32829) * Require type argument for JSDoc Array, Object, and Promise in noImplicitAny * add jsdoc Array/Object/Promise noImplicitAny tests
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.
Fixes #32766
As discussed in that issue, when
noImplicitAnyis set incheckJs, this change makes it an error to not specify a type argument in the jsdoc annotations for/** @type {Array} */,/** @type {Object} */, and/** @type {Promise} */the same way it is for all other jsdoc parameterized types.If not
noImplicitAny, nothing changes and the type argument(s) will continue to default toanyfor these three special cases.Also as discussed in #32766 (comment), dropping the
Object -> anymapping will be a bigger change than the other two types, thoughnoImplicitAnyandstrictcheckJsprojects are out there that will break with this change