preferredTypes
#247
Merged
preferredTypes
#247
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
brettz9
force-pushed
the
check-types-prefer-types
branch
from
a571c68 to
48b26d8
Compare
…port message - Change: `no-undefined-types` now automatically allows `NaN` and `Infinity` types - Enhancement: `check-types` and `no-undefined-types`: utilize `settings.jsdoc.preferredTypes` map - Enhancement: `check-types`: Add option object with `noDefaults` - Enhancement: `no-undefined-types`: Add option object with `preferredTypesAreDefined` and `definedTypes` - Docs: `no-undefined-types`: Mention role of globals
brettz9
force-pushed
the
check-types-prefer-types
branch
from
48b26d8 to
d8c3e6e
Compare
gajus
approved these changes
May 21, 2019
Collaborator
Author
|
Thanks for the reviews! Just wondering though about changing that default--are you inclined to keep it as it is or change it for |
This was referenced May 21, 2019
Owner
|
🎉 This PR is included in version 6.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
check-typeswill now include the preferred type in its report messageno-undefined-typesnow automatically allowsNaNandInfinitytypescheck-typesandno-undefined-types: utilizesettings.jsdoc.preferredTypesmapcheck-types: Add option object withnoDefaultsno-undefined-types: Add option object withpreferredTypesAreDefinedanddefinedTypesno-undefined-types: Mention role of globalsCloses #107, Closes #164, Closes #166, Closes #215 .
Also unblocks the one item I think is remaining for #1 , namely to correlate our new
preferredTypesto eslint's deprecatedvalid-jsdoc.Regarding #164, @gajus, I wonder if you want to also make a breaking change to the default behavior and require
objectinstead ofObject, given that valid-jsdoc did so and TypeScript recommends so. I think the rationale for this is thatObject.create(null)will create an object whosetypeofisobjectbut which is notinstanceof Object. While this PR allows overriding the default behavior, I think this makes sense as a new default as well, especially considering theObject.create(null)aspect.There is also one issue in this PR I have not been able to figure out, and wonder if it is an issue with eslint itself. Though I changed this to get the test to passed, what I would expect in line 477 at https://github.com/brettz9/eslint-plugin-jsdoc/blob/a571c68bb988732b45308f3f6ae0353ce71678b3/test/rules/assertions/checkTypes.js#L477 really would instead be "number" lower-cased, as I'd think that both reported errors for this test would be fixed, but only one is. This seems not to be tied to this specific problem but it appears to me only one fix can get made. Any idea why that is?