fix(eslint-plugin): [switch-exhaustiveness-check] add support for covering a missing property with `undefined` #10232

ronami · 2024-10-29T20:17:36Z

PR Checklist

Addresses an existing open issue: fixes Bug: [switch-exhaustiveness-check] False positive with noUncheckedIndexedAccess #10228
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

This PR resolves #10228. Apparently, TypeScript has a different type when a property could be missing rather than the standard undefined type. Both types have the same object flags but different debugIntrinsicName, making them not match for the current equality check (along with a different id key).

This issue isn't related to the recent fix in #10223 and can be tracked a while back. I didn't bother checking that the type is actually the missing type (it would require checking the currently untyped debugIntrinsicName) and just comparing for the standard undefined object flags (which match both the standard and the missing undefined types).

…undefined type

typescript-eslint · 2024-10-29T20:17:40Z

Thanks for the PR, @ronami!

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-29T20:17:53Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`64a712c`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/672266631efaa2000816cfc6
😎 Deploy Preview	https://deploy-preview-10232--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-29T20:18:29Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 64a712c. 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-29T20:33:33Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.50%. Comparing base (4af866a) to head (64a712c).
Report is 28 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #10232   +/-   ##
=======================================
  Coverage   86.50%   86.50%           
=======================================
  Files         430      430           
  Lines       15088    15091    +3     
  Branches     4380     4382    +2     
=======================================
+ Hits        13052    13055    +3     
  Misses       1679     1679           
  Partials      357      357

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

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

Files with missing lines	Coverage Δ
...nt-plugin/src/rules/switch-exhaustiveness-check.ts	`98.82% <100.00%> (+0.04%)`	⬆️

packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts

Co-authored-by: auvred <61150013+auvred@users.noreply.github.com>

auvred

💯

JoshuaKGoldberg

yay!

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

jtbandes · 2024-11-05T21:28:24Z

Thanks for the quick turnaround :)

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

don't report on the 'missing' undefined type if it's covered with an …

141eb59

…undefined type

ronami changed the title ~~fix(eslint): [switch-exhaustiveness-check] add support for covering a missing property with undefined~~ fix(eslint-plugin): [switch-exhaustiveness-check] add support for covering a missing property with undefined Oct 29, 2024

ronami added 2 commits October 29, 2024 22:56

projectService: false

f7ab3c4

projectService: false on valid test too

e52e44c

ronami marked this pull request as ready for review October 29, 2024 21:14

auvred requested changes Oct 30, 2024

View reviewed changes

packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts Outdated Show resolved Hide resolved

auvred added the awaiting response Issues waiting for a reply from the OP or another party label Oct 30, 2024

ronami and others added 2 commits October 30, 2024 18:57

Update packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts

674c158

Co-authored-by: auvred <61150013+auvred@users.noreply.github.com>

add relevant test

64a712c

ronami requested a review from auvred October 30, 2024 17:18

github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Oct 30, 2024

This comment was marked as off-topic.

Sign in to view

auvred approved these changes Nov 2, 2024

View reviewed changes

auvred 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 2, 2024

JoshuaKGoldberg approved these changes Nov 4, 2024

View reviewed changes

JoshuaKGoldberg merged commit f83a591 into typescript-eslint:main Nov 4, 2024
65 checks passed

ronami deleted the switch-exhaustiveness-check-missing-type branch November 4, 2024 14:25

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

fix(eslint-plugin): [switch-exhaustiveness-check] add support for covering a missing property with `undefined` #10232

fix(eslint-plugin): [switch-exhaustiveness-check] add support for covering a missing property with `undefined` #10232

ronami commented Oct 29, 2024 •

edited

Loading

typescript-eslint bot commented Oct 29, 2024

netlify bot commented Oct 29, 2024 •

edited

Loading

nx-cloud bot commented Oct 29, 2024 •

edited

Loading

codecov bot commented Oct 29, 2024 •

edited

Loading

This comment was marked as off-topic.

This comment was marked as off-topic.

auvred left a comment

JoshuaKGoldberg left a comment

jtbandes commented Nov 5, 2024

fix(eslint-plugin): [switch-exhaustiveness-check] add support for covering a missing property with undefined #10232

fix(eslint-plugin): [switch-exhaustiveness-check] add support for covering a missing property with undefined #10232

Conversation

ronami commented Oct 29, 2024 • edited Loading

PR Checklist

Overview

typescript-eslint bot commented Oct 29, 2024

netlify bot commented Oct 29, 2024 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

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

☁️ Nx Cloud Report

codecov bot commented Oct 29, 2024 • edited Loading

Codecov Report

This comment was marked as off-topic.

This comment was marked as off-topic.

auvred left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

jtbandes commented Nov 5, 2024

fix(eslint-plugin): [switch-exhaustiveness-check] add support for covering a missing property with `undefined` #10232

fix(eslint-plugin): [switch-exhaustiveness-check] add support for covering a missing property with `undefined` #10232

ronami commented Oct 29, 2024 •

edited

Loading

netlify bot commented Oct 29, 2024 •

edited

Loading

nx-cloud bot commented Oct 29, 2024 •

edited

Loading

codecov bot commented Oct 29, 2024 •

edited

Loading