typescript-eslint/typescript-eslintPublic

NotificationsYou must be signed in to change notification settings
Fork2.8k
Star15.7k

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

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

Jump to bottom

Merged

JoshuaKGoldberg merged 8 commits intotypescript-eslint:mainfromkirkwaiblinger:nuc-literal-comparisons

Nov 4, 2024

Merged

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

JoshuaKGoldberg merged 8 commits intotypescript-eslint:mainfromkirkwaiblinger:nuc-literal-comparisons

Nov 4, 2024

Conversation

Copy link

Member

kirkwaiblinger commentedOct 22, 2024

PR Checklist

Addresses an existing open issue:fixesBug: [no-unnecessary-condition] Confusing message when comparing a variable to all possible values #9643
That issue was marked asaccepting prs
Steps inContributing 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.

Copy link

Contributor

typescript-eslintbot commentedOct 22, 2024

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.

Copy link

netlifybot commentedOct 22, 2024•
edited
Loading

✅ Deploy Preview fortypescript-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 yourNetlify site configuration.

Copy link

nx-cloudbot commentedOct 22, 2024•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commiteb9ad53. 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 💌 fromNxCloud.

kirkwaiblinger force-pushed thenuc-literal-comparisons branch 2 times, most recently from5a3d55b toe28ee68Compare

October 22, 2024 06:24

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

c7adb29

kirkwaiblinger force-pushed thenuc-literal-comparisons branch frome28ee68 toc7adb29Compare

October 22, 2024 06:28

Copy link

codecovbot commentedOct 22, 2024•
edited
Loading

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 added5 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

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 \|\|

Copy link

MemberAuthor

kirkwaiblingerOct 22, 2024•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Note that I intentionally omitted thevoid check.

It is not tested for
We've gone towards thinking ofvoid asunknown in terms of its possible values, rather thanundefined 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

Copy link

MemberAuthor

kirkwaiblinger commentedOct 31, 2024

Note to self: align impl with changes in#10205

JoshuaKGoldberg reviewed

Nov 4, 2024

View reviewed changes

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

		line,
		messageId,
		});

Copy link

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

[Praise] Nice cleanup 😄

JoshuaKGoldberg previously approved these changes

Nov 4, 2024

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Copy link

Member

JoshuaKGoldberg commentedNov 4, 2024

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.

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

Copy link

MemberAuthor

kirkwaiblinger commentedNov 4, 2024•
edited
Loading

@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 👍

merge cleanup

eb9ad53

kirkwaiblinger dismissedJoshuaKGoldberg’sstale review viaeb9ad53

November 4, 2024 16:32

JoshuaKGoldberg added awaiting responseIssues 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 fromJoshuaKGoldberg

November 4, 2024 16:35

kirkwaiblinger removed the awaiting responseIssues waiting for a reply from the OP or another party label

Nov 4, 2024

JoshuaKGoldberg approved these changes

Nov 4, 2024

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

👍

JoshuaKGoldberg merged commit22f7f25 intotypescript-eslint:main

Nov 4, 2024

67 of 69 checks passed

kirkwaiblinger deleted the nuc-literal-comparisons branch

November 4, 2024 22:33

renovatebot added a commit to mmkal/eslint-plugin-mmkal that referenced this pull request

Nov 11, 2024

fix(deps): update typescript-eslint monorepo to v8.14.0

ffd7e61

##### [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 AmielYou 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.

renovatebot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request

Nov 12, 2024

Update typescript-eslint monorepo to v8.14.0

da248fc

| 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 AmielYou 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.

renovatebot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request

Nov 12, 2024

Update typescript-eslint monorepo to v8.14.0

d376526

| 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 AmielYou 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.

github-actionsbot locked asresolvedand limited conversation to collaborators

Nov 13, 2024

Labels

None yet

2 participants

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

Movatterモバイル変換

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 commentedOct 22, 2024

PR Checklist

Overview

Uh oh!

typescript-eslintbot commentedOct 22, 2024

Uh oh!

netlifybot commentedOct 22, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

✅ Deploy Preview fortypescript-eslint ready!

Uh oh!

nx-cloudbot commentedOct 22, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

codecovbot commentedOct 22, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Codecov Report

Uh oh!

kirkwaiblingerOct 22, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kirkwaiblinger commentedOct 31, 2024

Uh oh!

JoshuaKGoldbergNov 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 commentedNov 4, 2024

Uh oh!

kirkwaiblinger commentedNov 4, 2024• editedLoading 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!

netlifybot commentedOct 22, 2024•
edited
Loading

nx-cloudbot commentedOct 22, 2024•
edited
Loading

codecovbot commentedOct 22, 2024•
edited
Loading

kirkwaiblingerOct 22, 2024•
edited
Loading

kirkwaiblinger commentedNov 4, 2024•
edited
Loading