Prefer TypeScript compatibility #855
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
…s`, prefer `object` for plain objects and otherwise prefer `Object<>`; fixes gajus#800
|
🎉 This PR is included in version 38.1.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
crapStone
pushed a commit
to Calciumdibromid/CaBr2
that referenced
this pull request
Mar 31, 2022
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) | devDependencies | minor | [`38.0.8` -> `38.1.3`](https://renovatebot.com/diffs/npm/eslint-plugin-jsdoc/38.0.8/38.1.3) | --- ### Release Notes <details> <summary>gajus/eslint-plugin-jsdoc</summary> ### [`v38.1.3`](https://github.com/gajus/eslint-plugin-jsdoc/releases/v38.1.3) [Compare Source](gajus/eslint-plugin-jsdoc@v38.1.2...v38.1.3) ##### Bug Fixes - **`check-types`, `no-undefined-types`:** safer optional chaining ([63a96ee](gajus/eslint-plugin-jsdoc@63a96ee)) ### [`v38.1.2`](https://github.com/gajus/eslint-plugin-jsdoc/releases/v38.1.2) [Compare Source](gajus/eslint-plugin-jsdoc@v38.1.1...v38.1.2) ##### Bug Fixes - **`check-types`:** proper use of optional chaining; fixes [#​861](gajus/eslint-plugin-jsdoc#861) ([7dbdd9f](gajus/eslint-plugin-jsdoc@7dbdd9f)) ### [`v38.1.1`](https://github.com/gajus/eslint-plugin-jsdoc/releases/v38.1.1) [Compare Source](gajus/eslint-plugin-jsdoc@v38.1.0...v38.1.1) ##### Bug Fixes - **`check-types`:** for `jsdoc` mode, avoid objecting to upper-case; fixes [#​860](gajus/eslint-plugin-jsdoc#860) ([d11d271](gajus/eslint-plugin-jsdoc@d11d271)) ### [`v38.1.0`](https://github.com/gajus/eslint-plugin-jsdoc/releases/v38.1.0) [Compare Source](gajus/eslint-plugin-jsdoc@v38.0.8...v38.1.0) ##### Features - unless the user supplies their own `object` type `preferredTypes`, prefer `object` for plain objects and otherwise prefer `Object<>`; fixes [#​800](gajus/eslint-plugin-jsdoc#800) ([#​855](gajus/eslint-plugin-jsdoc#855)) ([0f27282](gajus/eslint-plugin-jsdoc@0f27282)) </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1262 Reviewed-by: 6543 <6543@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
turadg
added a commit
to Agoric/agoric-sdk
that referenced
this pull request
May 2, 2022
turadg
added a commit
to Agoric/ui-kit
that referenced
this pull request
Jun 12, 2023
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.
feat: unless the user supplies their own
objecttypepreferredTypes, preferobjectfor plain objects and otherwise preferObject<>; fixes #800I'm not yet convinced we're ready for #834 , but in anticipation of a likely future change, I think we should go ahead and enforce the best compatibility with TypeScript now even for plain jsdoc users.
Now admittedly, TypeScript has an issue to change things to support equivalent behavior for either form when within JSDoc, but regardless, it seems that it is better for us to enforce operating in a manner closer to how TypeScript is to behave (that
Objectis discouraged in plain form andobjectis the more basic type allowing forObject.create(null)) and how it makes sense to behave (if one JSDoc type is allowed thenObject` seems more like a generic-friendly form).