fix(eslint-plugin): [no-unnecessary-condition] improve error message for literal comparisons #10194

kirkwaiblinger · 2024-10-22T06:04:20Z

PR Checklist

Addresses an existing open issue: fixes Bug: [no-unnecessary-condition] Confusing message when comparing a variable to all possible values #9643
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

In addition to changing the wording, I've also had the error message compute whether the condition is actually true or false.

typescript-eslint · 2024-10-22T06:04:24Z

Thanks for the PR, @kirkwaiblinger!

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.

netlify · 2024-10-22T06:04:36Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`eb9ad53`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6728f70774cffd00088aaedc
😎 Deploy Preview	https://deploy-preview-10194--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 99 (no change from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 98 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

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

nx-cloud · 2024-10-22T06:05:12Z

☁️ Nx Cloud Report

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

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 2 targets

Sent with 💌 from NxCloud.

codecov · 2024-10-22T06:44:40Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.52%. Comparing base (f83a591) to head (eb9ad53).
Report is 5 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10194      +/-   ##
==========================================
+ Coverage   86.51%   86.52%   +0.01%     
==========================================
  Files         430      430              
  Lines       15124    15144      +20     
  Branches     4399     4404       +5     
==========================================
+ Hits        13084    13104      +20     
  Misses       1683     1683              
  Partials      357      357

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

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

Files with missing lines	Coverage Δ
...slint-plugin/src/rules/no-unnecessary-condition.ts	`99.20% <100.00%> (+0.06%)`	⬆️

kirkwaiblinger · 2024-10-22T15:38:27Z

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

-  tsutils.isBooleanLiteralType(type) ||
-  type.flags === ts.TypeFlags.Undefined ||
-  type.flags === ts.TypeFlags.Null ||
-  type.flags === ts.TypeFlags.Void ||


Note that I intentionally omitted the void check.

It is not tested for

We've gone towards thinking of void as unknown in terms of its possible values, rather than undefined only. And if it doesn't have a specific, knowable value such that we can precompute the condition... then it's an indication that we can't in good faith tell the user the condition is unnecessary due to both sides of the condition being known literal values.

Also I think TS bans most relevant usages of it anyways

kirkwaiblinger · 2024-10-31T18:36:53Z

Note to self: align impl with changes in #10205

JoshuaKGoldberg · 2024-11-04T15:47:36Z

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

-  line,
-  messageId,
-});
-


[Praise] Nice cleanup 😄

JoshuaKGoldberg

JoshuaKGoldberg · 2024-11-04T15:55:01Z

Note to self: align impl with changes in #10205

@kirkwaiblinger is there anything you still want to do here? I think it's ready for merge if not.

kirkwaiblinger · 2024-11-04T16:20:13Z

@kirkwaiblinger is there anything you still want to do here? I think it's ready for merge if not.

yeah, there's a bit of duplicated code, lemme just merge from main and clean that up 👍

JoshuaKGoldberg

👍

@gyumong

##### [v8.14.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8140-2024-11-11) ##### 🚀 Features - **eslint-plugin:** \[await-thenable] report unnecessary `await using` statements ([#10209](typescript-eslint/typescript-eslint#10209)) - **eslint-plugin:** \[no-confusing-void-expression] add an option to ignore void<->void ([#10067](typescript-eslint/typescript-eslint#10067)) ##### 🩹 Fixes - **scope-manager:** fix asserted increments not being marked as write references ([#10271](typescript-eslint/typescript-eslint#10271)) - **eslint-plugin:** \[no-misused-promises] improve report loc for methods ([#10216](typescript-eslint/typescript-eslint#10216)) - **eslint-plugin:** \[no-unnecessary-condition] improve error message for literal comparisons ([#10194](typescript-eslint/typescript-eslint#10194)) ##### ❤️ Thank You - Gyumong [@gyumong](https://github.com/Gyumong) - Jan Ochwat [@janek515](https://github.com/janek515) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - Ronen Amiel You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@gyumong

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.13.0 | 8.14.0 | | npm | @typescript-eslint/parser | 8.13.0 | 8.14.0 | ## [v8.14.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8140-2024-11-11) ##### 🚀 Features - **eslint-plugin:** \[await-thenable] report unnecessary `await using` statements ([#10209](typescript-eslint/typescript-eslint#10209)) - **eslint-plugin:** \[no-confusing-void-expression] add an option to ignore void<->void ([#10067](typescript-eslint/typescript-eslint#10067)) ##### 🩹 Fixes - **scope-manager:** fix asserted increments not being marked as write references ([#10271](typescript-eslint/typescript-eslint#10271)) - **eslint-plugin:** \[no-misused-promises] improve report loc for methods ([#10216](typescript-eslint/typescript-eslint#10216)) - **eslint-plugin:** \[no-unnecessary-condition] improve error message for literal comparisons ([#10194](typescript-eslint/typescript-eslint#10194)) ##### ❤️ Thank You - Gyumong [@gyumong](https://github.com/Gyumong) - Jan Ochwat [@janek515](https://github.com/janek515) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - Ronen Amiel You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@gyumong

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.13.0 | 8.14.0 | | npm | @typescript-eslint/parser | 8.13.0 | 8.14.0 | ## [v8.14.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8140-2024-11-11) ##### 🚀 Features - **eslint-plugin:** \[await-thenable] report unnecessary `await using` statements ([#10209](typescript-eslint/typescript-eslint#10209)) - **eslint-plugin:** \[no-confusing-void-expression] add an option to ignore void<->void ([#10067](typescript-eslint/typescript-eslint#10067)) ##### 🩹 Fixes - **scope-manager:** fix asserted increments not being marked as write references ([#10271](typescript-eslint/typescript-eslint#10271)) - **eslint-plugin:** \[no-misused-promises] improve report loc for methods ([#10216](typescript-eslint/typescript-eslint#10216)) - **eslint-plugin:** \[no-unnecessary-condition] improve error message for literal comparisons ([#10194](typescript-eslint/typescript-eslint#10194)) ##### ❤️ Thank You - Gyumong [@gyumong](https://github.com/Gyumong) - Jan Ochwat [@janek515](https://github.com/janek515) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - Ronen Amiel You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

kirkwaiblinger force-pushed the nuc-literal-comparisons branch 2 times, most recently from 5a3d55b to e28ee68 Compare October 22, 2024 06:24

no-unnecessary-condition: Improve error message for literal comparisons

c7adb29

kirkwaiblinger force-pushed the nuc-literal-comparisons branch from e28ee68 to c7adb29 Compare October 22, 2024 06:28

kirkwaiblinger added 5 commits October 22, 2024 00:45

lintfix

87c3a53

cov

dd15c0f

ts-api-utils bug workaround

07a6e23

cov

7065d0d

update todo with ts-api-utils issue

0b93e52

kirkwaiblinger marked this pull request as ready for review October 22, 2024 15:26

kirkwaiblinger commented Oct 22, 2024

View reviewed changes

JoshuaKGoldberg reviewed Nov 4, 2024

View reviewed changes

JoshuaKGoldberg previously approved these changes Nov 4, 2024

View reviewed changes

JoshuaKGoldberg added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Nov 4, 2024

Merge branch 'main' into nuc-literal-comparisons

347dcd4

merge cleanup

eb9ad53

kirkwaiblinger dismissed JoshuaKGoldberg’s stale review via eb9ad53 November 4, 2024 16:32

JoshuaKGoldberg added awaiting response Issues waiting for a reply from the OP or another party and removed 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge labels Nov 4, 2024

kirkwaiblinger requested a review from JoshuaKGoldberg November 4, 2024 16:35

kirkwaiblinger removed the awaiting response Issues waiting for a reply from the OP or another party label Nov 4, 2024

JoshuaKGoldberg approved these changes Nov 4, 2024

View reviewed changes

JoshuaKGoldberg merged commit 22f7f25 into typescript-eslint:main Nov 4, 2024
67 of 69 checks passed

kirkwaiblinger deleted the nuc-literal-comparisons branch November 4, 2024 22:33

github-actions bot locked as resolved and limited conversation to collaborators Nov 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(eslint-plugin): [no-unnecessary-condition] improve error message for literal comparisons #10194

fix(eslint-plugin): [no-unnecessary-condition] improve error message for literal comparisons #10194

Uh oh!

kirkwaiblinger commented Oct 22, 2024

Uh oh!

typescript-eslint bot commented Oct 22, 2024

Uh oh!

netlify bot commented Oct 22, 2024 •

edited

Loading

Uh oh!

nx-cloud bot commented Oct 22, 2024 •

edited

Loading

Uh oh!

codecov bot commented Oct 22, 2024 •

edited

Loading

Uh oh!

kirkwaiblinger Oct 22, 2024 •

edited

Loading

Uh oh!

kirkwaiblinger commented Oct 31, 2024

Uh oh!

JoshuaKGoldberg Nov 4, 2024

Uh oh!

JoshuaKGoldberg left a comment

Uh oh!

JoshuaKGoldberg commented Nov 4, 2024

Uh oh!

kirkwaiblinger commented Nov 4, 2024 •

edited

Loading

Uh oh!

JoshuaKGoldberg left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(eslint-plugin): [no-unnecessary-condition] improve error message for literal comparisons #10194

fix(eslint-plugin): [no-unnecessary-condition] improve error message for literal comparisons #10194

Uh oh!

Conversation

kirkwaiblinger commented Oct 22, 2024

PR Checklist

Overview

Uh oh!

typescript-eslint bot commented Oct 22, 2024

Uh oh!

netlify bot commented Oct 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for typescript-eslint ready!

Uh oh!

nx-cloud bot commented Oct 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

codecov bot commented Oct 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

kirkwaiblinger Oct 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kirkwaiblinger commented Oct 31, 2024

Uh oh!

JoshuaKGoldberg Nov 4, 2024

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg commented Nov 4, 2024

Uh oh!

kirkwaiblinger commented Nov 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

netlify bot commented Oct 22, 2024 •

edited

Loading

nx-cloud bot commented Oct 22, 2024 •

edited

Loading

codecov bot commented Oct 22, 2024 •

edited

Loading

kirkwaiblinger Oct 22, 2024 •

edited

Loading

kirkwaiblinger commented Nov 4, 2024 •

edited

Loading