fix(eslint-plugin): [switch-exhaustiveness-check] suggest with qualified name #10697

yeonjuan · 2025-01-22T12:11:18Z

PR Checklist

Addresses an existing open issue: fixes Bug: [switch-exhaustiveness-check] Enum cases are not properly qualified in fixer #7747
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

This pr addresses #7747.
The default TypeFormatFlags for the typeToString method is AllowUniqueESSymbolType | UseAliasDefinedOutsideCurrentScope.
This pr adds UseFullyQualifiedType to change the type to a qualified name.

TypeScript/src/compiler/checker.ts

function typeToString(
        type: Type,
        enclosingDeclaration?: Node,
        flags: TypeFormatFlags = TypeFormatFlags.AllowUniqueESSymbolType | TypeFormatFlags.UseAliasDefinedOutsideCurrentScope,
      // ...
    ): string {
        const noTruncation =

https://github.com/microsoft/TypeScript/blob/1c4083f4edc71cb1744a62013732e3c95d05a035/src/compiler/types.ts#L5538-L5540

    UseFullyQualifiedType                   = 1 << 6,  // Write out the fully qualified type name (eg. Module.Type, instead of Type)

…ied name

typescript-eslint · 2025-01-22T12:11:22Z

Thanks for the PR, @yeonjuan!

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 · 2025-01-22T12:11:47Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`a5414c3`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6790ea871a787e0008d99ea9
😎 Deploy Preview	https://deploy-preview-10697--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 85 (🔴 down 13 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 · 2025-01-22T12:12:11Z

View your CI Pipeline Execution ↗ for commit a5414c3.

Command	Status	Duration	Result
`nx run-many --target=build --exclude website --...`	✅ Succeeded	24s	View ↗
`nx run-many --target=clean`	✅ Succeeded	10s	View ↗

☁️ Nx Cloud last updated this comment at 2025-01-28 20:01:38 UTC

codecov · 2025-01-22T12:28:57Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.17%. Comparing base (79af426) to head (a5414c3).
Report is 23 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #10697   +/-   ##
=======================================
  Coverage   87.17%   87.17%           
=======================================
  Files         448      448           
  Lines       15598    15599    +1     
  Branches     4555     4555           
=======================================
+ Hits        13597    13598    +1     
  Misses       1645     1645           
  Partials      356      356

Flag	Coverage Δ
unittest	`87.17% <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.93% <100.00%> (+0.01%)`	⬆️

JoshuaKGoldberg

💯 thanks!

@OlivierZal

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.22.0 | 8.23.0 | | npm | @typescript-eslint/parser | 8.22.0 | 8.23.0 | ## [v8.23.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8230-2025-02-03) ##### 🚀 Features - **eslint-plugin:** \[no-unnecessary-boolean-literal-compare] enforce strictNullChecks ([#10712](typescript-eslint/typescript-eslint#10712)) ##### 🩹 Fixes - **eslint-plugin:** \[no-shadow] ignore declare variables in definition files shadowing global variables ([#10710](typescript-eslint/typescript-eslint#10710)) - **eslint-plugin:** \[no-restricted-imports] support regex option ([#10699](typescript-eslint/typescript-eslint#10699)) - **eslint-plugin:** \[dot-notation] handle noPropertyAccessFromIndexSignature true ([#10644](typescript-eslint/typescript-eslint#10644)) - **eslint-plugin:** \[prefer-nullish-coalescing] fix missing return ([#10732](typescript-eslint/typescript-eslint#10732)) - bump ts-api-utils to ^2.0.1 ([#10761](typescript-eslint/typescript-eslint#10761)) - **eslint-plugin:** \[no-unnecessary-template-expression] allow interpolating type parameter in type context ([#10739](typescript-eslint/typescript-eslint#10739)) - **eslint-plugin:** \[switch-exhaustiveness-check] suggest with qualified name ([#10697](typescript-eslint/typescript-eslint#10697)) - **eslint-plugin:** \[no-unnecessary-type-assertion] should report readonly class properties with a literal initializer ([#10618](typescript-eslint/typescript-eslint#10618)) ##### ❤️ Thank You - Josh Goldberg ✨ - Olivier Zalmanski [@OlivierZal](https://github.com/OlivierZal) - Ryan Poon [@sopa301](https://github.com/sopa301) - YeonJuan [@yeonjuan](https://github.com/yeonjuan) - Yukihiro Hasegawa [@y-hsgw](https://github.com/y-hsgw) 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.

@OlivierZal

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.22.0 | 8.23.0 | | npm | @typescript-eslint/parser | 8.22.0 | 8.23.0 | ## [v8.23.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8230-2025-02-03) ##### 🚀 Features - **eslint-plugin:** \[no-unnecessary-boolean-literal-compare] enforce strictNullChecks ([#10712](typescript-eslint/typescript-eslint#10712)) ##### 🩹 Fixes - **eslint-plugin:** \[no-shadow] ignore declare variables in definition files shadowing global variables ([#10710](typescript-eslint/typescript-eslint#10710)) - **eslint-plugin:** \[no-restricted-imports] support regex option ([#10699](typescript-eslint/typescript-eslint#10699)) - **eslint-plugin:** \[dot-notation] handle noPropertyAccessFromIndexSignature true ([#10644](typescript-eslint/typescript-eslint#10644)) - **eslint-plugin:** \[prefer-nullish-coalescing] fix missing return ([#10732](typescript-eslint/typescript-eslint#10732)) - bump ts-api-utils to ^2.0.1 ([#10761](typescript-eslint/typescript-eslint#10761)) - **eslint-plugin:** \[no-unnecessary-template-expression] allow interpolating type parameter in type context ([#10739](typescript-eslint/typescript-eslint#10739)) - **eslint-plugin:** \[switch-exhaustiveness-check] suggest with qualified name ([#10697](typescript-eslint/typescript-eslint#10697)) - **eslint-plugin:** \[no-unnecessary-type-assertion] should report readonly class properties with a literal initializer ([#10618](typescript-eslint/typescript-eslint#10618)) ##### ❤️ Thank You - Josh Goldberg ✨ - Olivier Zalmanski [@OlivierZal](https://github.com/OlivierZal) - Ryan Poon [@sopa301](https://github.com/sopa301) - YeonJuan [@yeonjuan](https://github.com/yeonjuan) - Yukihiro Hasegawa [@y-hsgw](https://github.com/y-hsgw) 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.

yeonjuan added 3 commits January 22, 2025 21:07

fix(eslint-plugin): [switch-exhaustiveness-check] suggest with qualif…

cd0701b

…ied name

add tests

375d3a8

Update switch-exhaustiveness-check.ts

6664774

fix lint errors

a5414c3

yeonjuan marked this pull request as ready for review January 22, 2025 15:23

JoshuaKGoldberg approved these changes Jan 28, 2025

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 Jan 28, 2025

kirkwaiblinger approved these changes Jan 28, 2025

View reviewed changes

JoshuaKGoldberg merged commit ac79d01 into typescript-eslint:main Feb 1, 2025
71 of 73 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Feb 9, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(eslint-plugin): [switch-exhaustiveness-check] suggest with qualified name #10697

fix(eslint-plugin): [switch-exhaustiveness-check] suggest with qualified name #10697

yeonjuan commented Jan 22, 2025 •

edited

Loading

typescript-eslint bot commented Jan 22, 2025

netlify bot commented Jan 22, 2025 •

edited

Loading

nx-cloud bot commented Jan 22, 2025 •

edited

Loading

codecov bot commented Jan 22, 2025 •

edited

Loading

JoshuaKGoldberg left a comment

fix(eslint-plugin): [switch-exhaustiveness-check] suggest with qualified name #10697

fix(eslint-plugin): [switch-exhaustiveness-check] suggest with qualified name #10697

Conversation

yeonjuan commented Jan 22, 2025 • edited Loading

PR Checklist

Overview

typescript-eslint bot commented Jan 22, 2025

netlify bot commented Jan 22, 2025 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

nx-cloud bot commented Jan 22, 2025 • edited Loading

codecov bot commented Jan 22, 2025 • edited Loading

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

yeonjuan commented Jan 22, 2025 •

edited

Loading

netlify bot commented Jan 22, 2025 •

edited

Loading

nx-cloud bot commented Jan 22, 2025 •

edited

Loading

codecov bot commented Jan 22, 2025 •

edited

Loading