fix(eslint-plugin): [no-unnecessary-condition] falsey bigint should be falsey #10205

peanutenthusiast · 2024-10-24T19:11:37Z

PR Checklist

Addresses an existing open issue: fixes Bug: [no-unnecessary-condition] should not say that falsey bigint is truthy #10197
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

This adds a utility function to check for a falseyBigInt. I implemented functions to convert type.value to BigInt when necessary, yet this still required the extra condition in checkNode for the specific edge case.

typescript-eslint · 2024-10-24T19:11:41Z

Thanks for the PR, @peanutenthusiast!

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-24T19:11:53Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`264d312`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6723ac0ec2f69600089fd95c
😎 Deploy Preview	https://deploy-preview-10205--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-24T19:12:29Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 264d312. 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.

… change test format for falsey big int

codecov · 2024-10-24T22:37:24Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.51%. Comparing base (beba27a) to head (3cc6ae6).
Report is 1 commits behind head on main.

❗ Current head 3cc6ae6 differs from pull request most recent head 264d312

Please upload reports for the commit 264d312 to get more accurate results.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #10205   +/-   ##
=======================================
  Coverage   86.50%   86.51%           
=======================================
  Files         430      430           
  Lines       15088    15098   +10     
  Branches     4380     4384    +4     
=======================================
+ Hits        13052    13062   +10     
  Misses       1679     1679           
  Partials      357      357

Flag	Coverage Δ
unittest	`86.51% <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.13% <100.00%> (+0.03%)`	⬆️

kirkwaiblinger

Good stuff, thanks for sending this in!

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

kirkwaiblinger · 2024-10-27T05:51:59Z

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

@@ -306,6 +326,8 @@ export default createRule<Options, MessageId>({
        messageId = !isUnaryNotArgument ? 'alwaysFalsy' : 'alwaysTruthy';
      } else if (!isPossiblyFalsy(type)) {
        messageId = !isUnaryNotArgument ? 'alwaysTruthy' : 'alwaysFalsy';
+      } else if (isFalseyBigInt(type)) {


oh, fun. This line "shouldn't" be necessary, since for 0n, !isPossiblyTruthy(type) should be true, since ts-api-utils's isFalsyType(type) should be true. But it's not, since ts-api-utils has the exact same bug that was in this rule!

https://github.com/JoshuaKGoldberg/ts-api-utils/blob/41cd21d41f445448681dd32308a48a004f4717cb/src/types/utilities.ts#L50

Filed JoshuaKGoldberg/ts-api-utils#544 to get that corrected. I'd say - let's move this workaround to the isPossiblyTruthy function instead just after the isFalsyType(type) check, and put a note that this is a workaround for the ts-api-utils bug

Lines 75-77 implement the suggested change and note.

Co-authored-by: Kirk Waiblinger <kirk.waiblinger@gmail.com>

…ork around

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

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

Co-authored-by: Kirk Waiblinger <kirk.waiblinger@gmail.com>

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

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

…-falsy

kirkwaiblinger · 2024-10-31T17:43:21Z

Looks great to me! Thank you for doing this, and handling some pretty surprising edge cases!

@auvred

##### [v8.13.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8130-2024-11-04) ##### 🚀 Features - **eslint-plugin:** \[only-throw-error] add allow option ([#10221](typescript-eslint/typescript-eslint#10221)) - **eslint-plugin:** \[prefer-nullish-coalescing] add option `ignoreBooleanCoercion` ([#9924](typescript-eslint/typescript-eslint#9924)) - **eslint-plugin:** disable `no-class-assign` rule in `eslint-recommended` config ([#10250](typescript-eslint/typescript-eslint#10250)) ##### 🩹 Fixes - **eslint-plugin:** \[switch-exhaustiveness-check] add support for covering a missing property with `undefined` ([#10232](typescript-eslint/typescript-eslint#10232)) - **eslint-plugin:** \[consistent-type-definitions] don't leave trailing parens when fixing type to interface ([#10235](typescript-eslint/typescript-eslint#10235)) - **eslint-plugin:** \[no-deprecated] report when exported class implements/extends deprecated entity ([#10259](typescript-eslint/typescript-eslint#10259)) - **eslint-plugin:** \[no-deprecated] report on deprecated variables used inside dynamic imports ([#10261](typescript-eslint/typescript-eslint#10261)) - **eslint-plugin:** \[no-unnecessary-condition] falsey bigint should be falsey ([#10205](typescript-eslint/typescript-eslint#10205)) ##### ❤️ Thank You - auvred [@auvred](https://github.com/auvred) - Kim Sang Du [@developer-bandi](https://github.com/developer-bandi) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - Mark de Dios [@peanutenthusiast](https://github.com/peanutenthusiast) - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) 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.

@auvred

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.12.2 | 8.13.0 | | npm | @typescript-eslint/parser | 8.12.2 | 8.13.0 | ## [v8.13.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8130-2024-11-04) ##### 🚀 Features - **eslint-plugin:** \[only-throw-error] add allow option ([#10221](typescript-eslint/typescript-eslint#10221)) - **eslint-plugin:** \[prefer-nullish-coalescing] add option `ignoreBooleanCoercion` ([#9924](typescript-eslint/typescript-eslint#9924)) - **eslint-plugin:** disable `no-class-assign` rule in `eslint-recommended` config ([#10250](typescript-eslint/typescript-eslint#10250)) ##### 🩹 Fixes - **eslint-plugin:** \[switch-exhaustiveness-check] add support for covering a missing property with `undefined` ([#10232](typescript-eslint/typescript-eslint#10232)) - **eslint-plugin:** \[consistent-type-definitions] don't leave trailing parens when fixing type to interface ([#10235](typescript-eslint/typescript-eslint#10235)) - **eslint-plugin:** \[no-deprecated] report when exported class implements/extends deprecated entity ([#10259](typescript-eslint/typescript-eslint#10259)) - **eslint-plugin:** \[no-deprecated] report on deprecated variables used inside dynamic imports ([#10261](typescript-eslint/typescript-eslint#10261)) - **eslint-plugin:** \[no-unnecessary-condition] falsey bigint should be falsey ([#10205](typescript-eslint/typescript-eslint#10205)) ##### ❤️ Thank You - auvred [@auvred](https://github.com/auvred) - Kim Sang Du [@developer-bandi](https://github.com/developer-bandi) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - Mark de Dios [@peanutenthusiast](https://github.com/peanutenthusiast) - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) 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.

@auvred

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.12.2 | 8.13.0 | | npm | @typescript-eslint/parser | 8.12.2 | 8.13.0 | ## [v8.13.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8130-2024-11-04) ##### 🚀 Features - **eslint-plugin:** \[only-throw-error] add allow option ([#10221](typescript-eslint/typescript-eslint#10221)) - **eslint-plugin:** \[prefer-nullish-coalescing] add option `ignoreBooleanCoercion` ([#9924](typescript-eslint/typescript-eslint#9924)) - **eslint-plugin:** disable `no-class-assign` rule in `eslint-recommended` config ([#10250](typescript-eslint/typescript-eslint#10250)) ##### 🩹 Fixes - **eslint-plugin:** \[switch-exhaustiveness-check] add support for covering a missing property with `undefined` ([#10232](typescript-eslint/typescript-eslint#10232)) - **eslint-plugin:** \[consistent-type-definitions] don't leave trailing parens when fixing type to interface ([#10235](typescript-eslint/typescript-eslint#10235)) - **eslint-plugin:** \[no-deprecated] report when exported class implements/extends deprecated entity ([#10259](typescript-eslint/typescript-eslint#10259)) - **eslint-plugin:** \[no-deprecated] report on deprecated variables used inside dynamic imports ([#10261](typescript-eslint/typescript-eslint#10261)) - **eslint-plugin:** \[no-unnecessary-condition] falsey bigint should be falsey ([#10205](typescript-eslint/typescript-eslint#10205)) ##### ❤️ Thank You - auvred [@auvred](https://github.com/auvred) - Kim Sang Du [@developer-bandi](https://github.com/developer-bandi) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - Mark de Dios [@peanutenthusiast](https://github.com/peanutenthusiast) - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) 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.

peanutenthusiast added 2 commits October 23, 2024 11:33

Add unnecessary condition test for falsey big int

d66a79e

Add function to get big int from pseudo big int

159c5fb

peanutenthusiast changed the title ~~Fix/10197/big falsey bigint should be always falsy~~ fix(eslint-plugin): [no-unnecessary-condition] falsey bigint should be falsey Oct 24, 2024

peanutenthusiast added 2 commits October 24, 2024 13:32

Remove semicolons from getValue function in no unnecessary condition,…

e9e6830

… change test format for falsey big int

Add utility function to check if type is falsey big int

c5e57ee

peanutenthusiast marked this pull request as ready for review October 24, 2024 22:27

kirkwaiblinger requested changes Oct 27, 2024

View reviewed changes

peanutenthusiast and others added 2 commits October 27, 2024 14:13

Remove check for base10Value in valueIsPseudoBigInt

4a858e6

Co-authored-by: Kirk Waiblinger <kirk.waiblinger@gmail.com>

Add isFalseyBigInt invocation to isPossibly truthy for ts api utils w…

986e138

…ork around

peanutenthusiast requested a review from kirkwaiblinger October 28, 2024 20:22

kirkwaiblinger requested changes Oct 30, 2024

View reviewed changes

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

packages/eslint-plugin/tests/rules/no-unnecessary-condition.test.ts Outdated Show resolved Hide resolved

peanutenthusiast and others added 3 commits October 30, 2024 12:28

Add test cases for positive and negative bigint values

ac06300

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

ee0544f

Co-authored-by: Kirk Waiblinger <kirk.waiblinger@gmail.com>

Add valid test case for bigint: 0n | 1n

4819d64

Josh-Cena reviewed Oct 31, 2024

View reviewed changes

packages/eslint-plugin/src/rules/no-unnecessary-condition.ts Outdated Show resolved Hide resolved

peanutenthusiast and others added 3 commits October 31, 2024 08:16

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

d916627

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

Fix isFalsyBigInt invocation

3cc6ae6

Merge branch 'main' into fix/10197/big-falsey-bigint-should-be-always…

264d312

…-falsy

kirkwaiblinger approved these changes Oct 31, 2024

View reviewed changes

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

kirkwaiblinger requested a review from Josh-Cena October 31, 2024 17:43

github-actions bot removed the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Oct 31, 2024

Josh-Cena approved these changes Oct 31, 2024

View reviewed changes

kirkwaiblinger merged commit 964fa91 into typescript-eslint:main Oct 31, 2024
61 of 63 checks passed

kirkwaiblinger mentioned this pull request Oct 31, 2024

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

Merged

3 tasks

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(eslint-plugin): [no-unnecessary-condition] falsey bigint should be falsey #10205

fix(eslint-plugin): [no-unnecessary-condition] falsey bigint should be falsey #10205

peanutenthusiast commented Oct 24, 2024 •

edited

Loading

typescript-eslint bot commented Oct 24, 2024

netlify bot commented Oct 24, 2024 •

edited

Loading

nx-cloud bot commented Oct 24, 2024 •

edited

Loading

codecov bot commented Oct 24, 2024 •

edited

Loading

kirkwaiblinger left a comment

kirkwaiblinger Oct 27, 2024

peanutenthusiast Oct 28, 2024

kirkwaiblinger commented Oct 31, 2024

fix(eslint-plugin): [no-unnecessary-condition] falsey bigint should be falsey #10205

fix(eslint-plugin): [no-unnecessary-condition] falsey bigint should be falsey #10205

Conversation

peanutenthusiast commented Oct 24, 2024 • edited Loading

PR Checklist

Overview

typescript-eslint bot commented Oct 24, 2024

netlify bot commented Oct 24, 2024 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

nx-cloud bot commented Oct 24, 2024 • edited Loading

☁️ Nx Cloud Report

codecov bot commented Oct 24, 2024 • edited Loading

Codecov Report

kirkwaiblinger left a comment

Choose a reason for hiding this comment

kirkwaiblinger Oct 27, 2024

Choose a reason for hiding this comment

peanutenthusiast Oct 28, 2024

Choose a reason for hiding this comment

kirkwaiblinger commented Oct 31, 2024

peanutenthusiast commented Oct 24, 2024 •

edited

Loading

netlify bot commented Oct 24, 2024 •

edited

Loading

nx-cloud bot commented Oct 24, 2024 •

edited

Loading

codecov bot commented Oct 24, 2024 •

edited

Loading