Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
fix(eslint-plugin): [no-unnecessary-condition] account for optional chaining on potentially void values#6432
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
fix(eslint-plugin): [no-unnecessary-condition] account for optional chaining on potentially void values#6432
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Thanks for the PR,@cparros! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently onhttps://opencollective.com/typescript-eslint. |
nx-cloudbot commentedFeb 7, 2023 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
netlifybot commentedFeb 7, 2023 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
✅ Deploy Preview fortypescript-eslint ready!
To edit notification comments on pull requests, go to yourNetlify site settings. |
codecovbot commentedFeb 7, 2023 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Codecov Report
Additional details and impacted files@@ Coverage Diff @@## main #6432 +/- ##======================================= Coverage 91.53% 91.53% ======================================= Files 371 371 Lines 12662 12663 +1 Branches 3721 3721 =======================================+ Hits 11590 11591 +1 Misses 754 754 Partials 318 318
Flags with carried forward coverage won't be shown.Click here to find out more.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
A good start - glad it's only a little bit of code to fix the bug! Let's get it toeven less. 🚀
` | ||
let variable = 'abc' as string | void; | ||
variable?.[0]; | ||
`, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I looked around the test file and found a few similar tests. Example:let foo: undefined | { bar: true };
. Could you move this near them?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Moved!
return ( | ||
isTypeAnyType(type) || | ||
isTypeUnknownType(type) || | ||
(isNullableType(type, { allowUndefined: true }) && isOwnNullable) | ||
(isNullableType(type, { allowUndefined: true }) && isOwnNullable) || | ||
(possiblyVoid && isOwnNullable) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
The&& isOwnNullable
is duplicated here. Let's simplify:
(isOwnNullable&&(isNullableType(type,{allowUndefined:true})||possiblyVoid))
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Updated
const unionParts = unionTypeParts(type); | ||
const possiblyVoid = unionParts.some( | ||
part => part.flags & ts.TypeFlags.Void, | ||
); | ||
return ( | ||
isTypeAnyType(type) || | ||
isTypeUnknownType(type) || |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Interesting:isTypeAnyType(type) and
isTypeUnknownType(type)both are working fine even if the type is a union. Both of those functions narrow down to checking
isTypeFlagSet(type, ts.TypeFlags.Something)`.
I tried switching from thepossiblyVoid
variable to checkingisTypeFlagSet(type, ts.TypeFlags.Void
- and it seems to work! So I think my hunch about usingunionTypeParts
was wrong 😄.
Tip: TypeScript's flags enums such asts.TypeFlags
work with checks likeisTypeFlagSet(type, ts.TypeFlags.One | ts.TypeFlags.Two)
. So you should be able to replaceisTypeAnyType(type) || isTypeUnknownType(type)
with a singleisTypeFlagSet
check.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This is great to know! Done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This PR contains the following updates:| Package | Type | Update | Change ||---|---|---|---|| [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.51.0` -> `5.52.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.51.0/5.52.0) || [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.51.0` -> `5.52.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.51.0/5.52.0) |---### Release Notes<details><summary>typescript-eslint/typescript-eslint (@​typescript-eslint/eslint-plugin)</summary>### [`v5.52.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#​5520-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5510v5520-2023-02-13)[Compare Source](typescript-eslint/typescript-eslint@v5.51.0...v5.52.0)##### Bug Fixes- **eslint-plugin:** \[no-import-type-side-effects] correctly ignore zero-specifier imports ([#​6444](typescript-eslint/typescript-eslint#6444)) ([d5a6688](typescript-eslint/typescript-eslint@d5a6688))- **eslint-plugin:** \[no-unnecessary-condition] account for optional chaining on potentially void values ([#​6432](typescript-eslint/typescript-eslint#6432)) ([e1d9c67](typescript-eslint/typescript-eslint@e1d9c67)), closes [#​5255](typescript-eslint/typescript-eslint#5255)- **eslint-plugin:** \[no-unnecessary-condition] fix false positive when checking indexed access types ([#​6452](typescript-eslint/typescript-eslint#6452)) ([d569924](typescript-eslint/typescript-eslint@d569924))- **eslint-plugin:** fix key-spacing when type starts on next line ([#​6412](typescript-eslint/typescript-eslint#6412)) ([3eb2eed](typescript-eslint/typescript-eslint@3eb2eed))##### Features- **eslint-plugin:** \[block-spacing] extending base rule for TS related blocks ([#​6195](typescript-eslint/typescript-eslint#6195)) ([b2db3f5](typescript-eslint/typescript-eslint@b2db3f5))- **eslint-plugin:** \[explicit-function-return-type] add allowFunctionsWithoutTypeParameters option ([#​6105](typescript-eslint/typescript-eslint#6105)) ([113640e](typescript-eslint/typescript-eslint@113640e))- **eslint-plugin:** \[explicit-function-return-type] add allowIIFEs option ([#​6237](typescript-eslint/typescript-eslint#6237)) ([a1b3f7b](typescript-eslint/typescript-eslint@a1b3f7b))</details><details><summary>typescript-eslint/typescript-eslint (@​typescript-eslint/parser)</summary>### [`v5.52.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#​5520-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5510v5520-2023-02-13)[Compare Source](typescript-eslint/typescript-eslint@v5.51.0...v5.52.0)**Note:** Version bump only for package [@​typescript-eslint/parser](https://github.com/typescript-eslint/parser)</details>---### Configuration📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - 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 these updates again.--- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box---This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMzMuMCIsInVwZGF0ZWRJblZlciI6IjM0LjEzNi4wIn0=-->Co-authored-by: cabr2-bot <cabr2.help@gmail.com>Reviewed-on:https://codeberg.org/Calciumdibromid/CaBr2/pulls/1784Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org>Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
PR Checklist
void
values #6261Overview
This PR adds a check for
void
types in the [no-unnecessary-condition] rule. It also adds a valid test case to its valid tests array.