fix(eslint-plugin): [no-unnecessary-condition] account for optional chaining on potentially void values #6432

cparros · 2023-02-07T01:05:36Z

PR Checklist

Addresses an existing open issue: fixes Bug: [no-unnecessary-condition] Does not account for optional chaining on potentially-void values #6261
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

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.

typescript-eslint · 2023-02-07T01:05:38Z

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 on https://opencollective.com/typescript-eslint.

nx-cloud · 2023-02-07T01:05:39Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit c63f694. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 47 targets

Sent with 💌 from NxCloud.

netlify · 2023-02-07T01:05:41Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`c63f694`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/63e3319b42285900082bbd35
😎 Deploy Preview	https://deploy-preview-6432--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

codecov · 2023-02-07T01:20:15Z

Codecov Report

Merging #6432 (c63f694) into main (3e102fe) will increase coverage by 0.00%.
The diff coverage is 100.00%.

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

Flag	Coverage Δ
unittest	`91.53% <100.00%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...slint-plugin/src/rules/no-unnecessary-condition.ts	`98.34% <100.00%> (+<0.01%)`	⬆️

JoshuaKGoldberg

A good start - glad it's only a little bit of code to fix the bug! Let's get it to even less. 🚀

JoshuaKGoldberg · 2023-02-07T16:27:14Z

packages/eslint-plugin/tests/rules/no-unnecessary-condition.test.ts

+    `
+let variable = 'abc' as string | void;
+variable?.[0];
+    `,


I looked around the test file and found a few similar tests. Example: let foo: undefined | { bar: true };. Could you move this near them?

JoshuaKGoldberg · 2023-02-07T16:48:49Z

packages/eslint-plugin/src/rules/no-unnecessary-condition.ts

      return (
        isTypeAnyType(type) ||
        isTypeUnknownType(type) ||
-        (isNullableType(type, { allowUndefined: true }) && isOwnNullable)
+        (isNullableType(type, { allowUndefined: true }) && isOwnNullable) ||
+        (possiblyVoid && isOwnNullable)


The && isOwnNullable is duplicated here. Let's simplify:

(isOwnNullable && (isNullableType(type, { allowUndefined: true }) || possiblyVoid))

JoshuaKGoldberg · 2023-02-07T16:53:15Z

packages/eslint-plugin/src/rules/no-unnecessary-condition.ts

+      const unionParts = unionTypeParts(type);
+      const possiblyVoid = unionParts.some(
+        part => part.flags & ts.TypeFlags.Void,
+      );
      return (
        isTypeAnyType(type) ||
        isTypeUnknownType(type) ||


Interesting: isTypeAnyType(type) and isTypeUnknownType(type)both are working fine even if the type is a union. Both of those functions narrow down to checkingisTypeFlagSet(type, ts.TypeFlags.Something)`.

I tried switching from the possiblyVoid variable to checking isTypeFlagSet(type, ts.TypeFlags.Void - and it seems to work! So I think my hunch about using unionTypeParts was wrong 😄.

Tip: TypeScript's flags enums such as ts.TypeFlags work with checks like isTypeFlagSet(type, ts.TypeFlags.One | ts.TypeFlags.Two). So you should be able to replace isTypeAnyType(type) || isTypeUnknownType(type) with a single isTypeFlagSet check.

This is great to know! Done.

bradzacher

this is looking good to me!
thanks for fixing this!

stale

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. --- - [ ] If you want to rebase/retry this PR, check this box --- 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/1784 Reviewed-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>

cparros added 2 commits February 5, 2023 22:07

Update error message per typescript-eslint#5255 discussion

f68b09f

Add void check to no-unnecessary-condition and test case

25ccd33

cparros changed the title ~~fix(eslint-plugin):[no-unnecessary-condition] void check and test~~ feat(eslint-plugin): [no-unnecessary-condition] void check and test Feb 7, 2023

cparros changed the title ~~feat(eslint-plugin): [no-unnecessary-condition] void check and test~~ feat(eslint-plugin): [no-unnecessary-condition] account for optional chaining on potentially void values Feb 7, 2023

JoshuaKGoldberg previously requested changes Feb 7, 2023

View reviewed changes

JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Feb 7, 2023

Cleanup, update type checks

c63f694

bradzacher added enhancement New feature or request awaiting response Issues waiting for a reply from the OP or another party and removed awaiting response Issues waiting for a reply from the OP or another party labels Feb 10, 2023

bradzacher approved these changes Feb 10, 2023

View reviewed changes

bradzacher added bug Something isn't working and removed enhancement New feature or request awaiting response Issues waiting for a reply from the OP or another party labels Feb 10, 2023

bradzacher changed the title ~~feat(eslint-plugin): [no-unnecessary-condition] account for optional chaining on potentially void values~~ fix(eslint-plugin): [no-unnecessary-condition] account for optional chaining on potentially void values Feb 10, 2023

bradzacher requested a review from JoshuaKGoldberg February 10, 2023 04:16

bradzacher added this pull request to the merge queue Feb 10, 2023

Merged via the queue into typescript-eslint:main with commit e1d9c67 Feb 10, 2023

github-actions bot locked as resolved and limited conversation to collaborators Feb 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(eslint-plugin): [no-unnecessary-condition] account for optional chaining on potentially void values #6432

fix(eslint-plugin): [no-unnecessary-condition] account for optional chaining on potentially void values #6432

cparros commented Feb 7, 2023

typescript-eslint bot commented Feb 7, 2023

nx-cloud bot commented Feb 7, 2023 •

edited

Loading

netlify bot commented Feb 7, 2023 •

edited

Loading

codecov bot commented Feb 7, 2023 •

edited

Loading

JoshuaKGoldberg left a comment

JoshuaKGoldberg Feb 7, 2023

cparros Feb 8, 2023

JoshuaKGoldberg Feb 7, 2023

cparros Feb 8, 2023

JoshuaKGoldberg Feb 7, 2023

cparros Feb 8, 2023

bradzacher left a comment

fix(eslint-plugin): [no-unnecessary-condition] account for optional chaining on potentially void values #6432

fix(eslint-plugin): [no-unnecessary-condition] account for optional chaining on potentially void values #6432

Conversation

cparros commented Feb 7, 2023

PR Checklist

Overview

typescript-eslint bot commented Feb 7, 2023

nx-cloud bot commented Feb 7, 2023 • edited Loading

☁️ Nx Cloud Report

netlify bot commented Feb 7, 2023 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

codecov bot commented Feb 7, 2023 • edited Loading

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg Feb 7, 2023

Choose a reason for hiding this comment

cparros Feb 8, 2023

Choose a reason for hiding this comment

JoshuaKGoldberg Feb 7, 2023

Choose a reason for hiding this comment

cparros Feb 8, 2023

Choose a reason for hiding this comment

JoshuaKGoldberg Feb 7, 2023

Choose a reason for hiding this comment

cparros Feb 8, 2023

Choose a reason for hiding this comment

bradzacher left a comment

Choose a reason for hiding this comment

nx-cloud bot commented Feb 7, 2023 •

edited

Loading

netlify bot commented Feb 7, 2023 •

edited

Loading

codecov bot commented Feb 7, 2023 •

edited

Loading