Skip to content

fix(eslint-plugin): [no-unnecessary-type-conversion] ignore enum members #11490

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

thebolarin
Copy link

PR Checklist

Overview

The no-unnecessary-type-conversion rule was incorrectly reporting violations when .toString() was called on enum members. While enums may be string-like or number-like under the hood, they are conceptually opaque types in TypeScript.

The rule now skips reporting for enum types and enum members by checking their type and symbol flags. This prevents false positives where calling .toString() is valid and sometimes necessary, and avoids conflicts with no-unsafe-enum-comparison

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @thebolarin!

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

netlify bot commented Aug 16, 2025

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 3cf00da
🔍 Latest deploy log https://app.netlify.com/projects/typescript-eslint/deploys/68a4e9a71f32730008d525af
😎 Deploy Preview https://deploy-preview-11490--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 81 (🔴 down 13 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (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 project configuration.

Copy link

nx-cloud bot commented Aug 16, 2025

View your CI Pipeline Execution ↗ for commit 3cf00da

Command Status Duration Result
nx test eslint-plugin --coverage=false ✅ Succeeded 5m 13s View ↗
nx run-many -t lint ✅ Succeeded 3m 13s View ↗
nx run-many -t typecheck ✅ Succeeded 2m 15s View ↗
nx test eslint-plugin-internal --coverage=false ✅ Succeeded 5s View ↗
nx test typescript-estree --coverage=false ✅ Succeeded 2s View ↗
nx run types:build ✅ Succeeded 5s View ↗
nx run integration-tests:test ✅ Succeeded 3s View ↗
nx run generate-configs ✅ Succeeded 6s View ↗
Additional runs (27) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2025-08-19 21:30:34 UTC

@thebolarin thebolarin changed the title fix: enums in no-unnecessary-type-conversion fix(eslint-plugin): enums in no-unnecessary-type-conversion Aug 17, 2025
@thebolarin thebolarin force-pushed the fix/no-unnecessary-type-conversion-enum branch from 02c5652 to 566410b Compare August 18, 2025 18:43
Copy link

codecov bot commented Aug 18, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.87%. Comparing base (369ccab) to head (3cf00da).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #11490   +/-   ##
=======================================
  Coverage   90.87%   90.87%           
=======================================
  Files         505      505           
  Lines       51146    51159   +13     
  Branches     8424     8428    +4     
=======================================
+ Hits        46480    46493   +13     
  Misses       4652     4652           
  Partials       14       14           
Flag Coverage Δ
unittest 90.87% <100.00%> (+<0.01%) ⬆️

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

Files with missing lines Coverage Δ
...plugin/src/rules/no-unnecessary-type-conversion.ts 100.00% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@bradzacher bradzacher changed the title fix(eslint-plugin): enums in no-unnecessary-type-conversion fix(eslint-plugin): [no-unnecessary-type-conversion] ignore enum members Aug 18, 2025
Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

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

thanks!

Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

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

/home/runner/work/typescript-eslint/typescript-eslint/packages/eslint-plugin/src/rules/no-unnecessary-type-conversion.ts
  27:12  error  Unnecessary conditional, expected left-hand side of `??` operator to be possibly null or undefined  @typescript-eslint/no-unnecessary-condition
  27:12  error  Do not use Type.symbol because it is poorly typed. Use Type.getSymbol() instead                     @typescript-eslint/internal/no-poorly-typed-ts-props
  27:23  error  Unnecessary optional chain on a non-nullish value                                                   @typescript-eslint/no-unnecessary-condition

there are some lint errors to fix

@bradzacher bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label Aug 18, 2025
@thebolarin thebolarin force-pushed the fix/no-unnecessary-type-conversion-enum branch from ac38a26 to 1391151 Compare August 18, 2025 23:10
@thebolarin thebolarin force-pushed the fix/no-unnecessary-type-conversion-enum branch from 1391151 to be5ba37 Compare August 18, 2025 23:27
@thebolarin
Copy link
Author

thebolarin commented Aug 18, 2025

/home/runner/work/typescript-eslint/typescript-eslint/packages/eslint-plugin/src/rules/no-unnecessary-type-conversion.ts
  27:12  error  Unnecessary conditional, expected left-hand side of `??` operator to be possibly null or undefined  @typescript-eslint/no-unnecessary-condition
  27:12  error  Do not use Type.symbol because it is poorly typed. Use Type.getSymbol() instead                     @typescript-eslint/internal/no-poorly-typed-ts-props
  27:23  error  Unnecessary optional chain on a non-nullish value                                                   @typescript-eslint/no-unnecessary-condition

there are some lint errors to fix

@bradzacher Thanks for the review. I have pushed some changes to fix that

@thebolarin thebolarin force-pushed the fix/no-unnecessary-type-conversion-enum branch from be5ba37 to 5fc90c4 Compare August 19, 2025 08:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting response Issues waiting for a reply from the OP or another party
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: [no-unnecessary-type-conversion] rule reports on enum types which should be treated as opaque
2 participants