-
-
Notifications
You must be signed in to change notification settings - Fork 164
check-types can't decide on object vs. Object<> #860
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
🎉 This issue has been resolved in version 38.1.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Apologies, hadn't caught that plain jsdoc mode had another check still present insisting on In the new fixed release, it should be upper-case when there is a child type, e.g., |
@brettz9: There is nothing to apologize for. You are doing a very good job. Thank you so much for fixing this issue so quickly! |
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 <[email protected]> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1262 Reviewed-by: 6543 <[email protected]> Co-authored-by: Calciumdibromid Bot <[email protected]> Co-committed-by: Calciumdibromid Bot <[email protected]>
Expected behavior
I'm trying to update to version 38.1.0 but I have an issue with "object" arguments. I expect one of the following to be correct.
Either the lowercase "object":
but I get
or the uppercase object:
but I get
Actual behavior
I'm very happy having to make my jsdoc uniform, but the check-type rule has to decide whether it wants uppercase or lowercase
object
, it can't be both :-).ESLint Config
ESLint sample
Environment
eslint-plugin-jsdoc
version: 38.1.0The text was updated successfully, but these errors were encountered: