fix(eslint-plugin): [consistent-type-assertions] wrap object return value with parentheses

[dora1998]

PR Checklist

• Addresses an existing open issue: fixes Bug: [consistent-type-assertions] autofix breaks type assertion of return value #6884
• That issue was marked as accepting prs
• Steps in Contributing were taken

Overview

Wrap type assertion with parentheses if object literal type and used as return value of arrow function.

[typescript-eslint]

Thanks for the PR, @dora1998!

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]

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	6948bfd
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/64ea4cca299c0700079a2ec9
😎 Deploy Preview	https://deploy-preview-6885--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 6948bfd. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 40 targets

• nx test eslint-plugin --coverage=false
• Node 20 - nx test eslint-plugin
• Node 16 - nx test eslint-plugin --coverage=false
• nx build website
• nx test eslint-plugin-tslint --coverage=false
• nx run types:build
• nx run repo-tools:postinstall-script
• nx test typescript-estree --coverage=false
• Node 20 - nx test type-utils
• Node 20 - nx run types:build
• Node 20 - nx test repo-tools
• Node 20 - nx run repo-tools:postinstall-script
• Node 20 - nx test rule-schema-to-typescript-types
• Node 20 - nx test scope-manager
• Node 20 - nx test visitor-keys
• nx test eslint-plugin-internal --coverage=false
• Node 20 - nx test utils
• Node 20 - nx test typescript-estree
• Node 20 - nx test eslint-plugin-tslint
• Node 20 - nx test parser
• Node 20 - nx test eslint-plugin-internal
• Node 20 - nx test ast-spec
• nx run-many --target=typecheck --parallel
• Node 16 - nx test visitor-keys --coverage=false
• Node 16 - nx test typescript-estree --coverage=false
• Node 16 - nx run types:build
• Node 16 - nx test rule-schema-to-typescript-types --coverage=false
• Node 16 - nx test parser --coverage=false
• Node 16 - nx test scope-manager --coverage=false
• Node 16 - nx test utils --coverage=false
• Node 16 - nx test type-utils --coverage=false
• Node 16 - nx run repo-tools:postinstall-script
• Node 16 - nx test eslint-plugin-internal --coverage=false
• Node 16 - nx test eslint-plugin-tslint --coverage=false
• Node 16 - nx test repo-tools --coverage=false
• nx run-many --target=lint --parallel
• Node 16 - nx test ast-spec --coverage=false
• nx run integration-tests:test
• nx run eslint-plugin:generate:configs
• nx run-many --target=build --parallel --exclude=website --exclude=website-eslint

---

Sent with 💌 from NxCloud.

[codecov]

Codecov Report

Merging #6885 (6948bfd) into main (85f34da) will increase coverage by 0.00%.
The diff coverage is 85.00%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6885   +/-   ##
=======================================
  Coverage   87.22%   87.23%           
=======================================
  Files         386      387    +1     
  Lines       13383    13401   +18     
  Branches     3955     3962    +7     
=======================================
+ Hits        11673    11690   +17     
+ Misses       1328     1327    -1     
- Partials      382      384    +2     

Flag	Coverage Δ
unittest	87.23% <85.00%> (+<0.01%)	⬆️

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

Files Changed	Coverage Δ
...es/eslint-plugin/src/util/getOperatorPrecedence.ts	41.07% <ø> (+3.57%)	⬆️
...ackages/eslint-plugin/src/util/getWrappingFixer.ts	98.48% <75.00%> (-1.52%)	⬇️
...int-plugin/src/rules/consistent-type-assertions.ts	91.04% <85.71%> (-1.55%)	⬇️
packages/eslint-plugin/src/util/getWrappedCode.ts	100.00% <100.00%> (ø)

[JoshuaKGoldberg]

LGTM in general - and love that you're fixing an issue you filed so quickly! 😍

Just requesting changes on generalizing the fix if possible - since it's very likely to come up again. Thanks!

[JoshuaKGoldberg]

LGTM, great test cases! Glad to see a reuse of the existing shared code. Thanks! 🙌

Since I haven't touched the getWrappingFixer util area much, marking as 1 approval and waiting for someone else to approve as well.

[JoshuaKGoldberg]

cc @armano2 - is this still something you want to look at?

If not, no worries, I feel comfortable merging :)

[bradzacher]

big oof - the entire packages/eslint-plugin/src/util/getWrappingFixer.ts file probably needs to be rewritten because right now it uses its own hard-coded precedence logic, rather than using our precedence utilities

[dora1998]

@bradzacher
I added getWrappedCode util function that wrap text in parens if needed because of precedence.
(I think it can also replace isLeftSideLowerPrecedence and isHigherPrecedenceThanUnary)

but It's hard to replace getWrapped with getWrappedCode because now we have to know precedence of node and all innerNodes..., so I'd like to hear your opinion.

---

By the way, lint and unit test is failing in CI but successful in my local environment. Will merging the main branch fix this...?

[JoshuaKGoldberg]

Fun merge conflict artifact: we switched to ts-api-utils in v6.

[JoshuaKGoldberg]

By the way, lint and unit test is failing in CI but successful in my local environment. Will merging the main branch fix this...?

Yeah that should fix it. I don't like throwing extra work your way so I'll go ahead and merge now.

[JoshuaKGoldberg]

@armano2 do you still have time for this?

No worries if not, now that you've taken at least one look I feel comfortable re-reviewing and approving & merging if it's good to go.

[dora1998]

@JoshuaKGoldberg Sorry for my late reply...
Thank you so much for taking over my PR ✨

[JoshuaKGoldberg]

Swell, thanks for such a thorough change! 🙌

[alecmev]

Does this not make consistent-type-assertions typed?

[polyzen]

Does this not make consistent-type-assertions typed?

Seems to be the case. I'm using the following:

'plugin:@typescript-eslint/strict',
'plugin:@typescript-eslint/stylistic',

and getting the following error:
Error: Error while loading rule '@typescript-eslint/consistent-type-assertions': You have used a rule which requires parserServices to be generated. You must therefore provide a value for the "parserOptions.project" property for @typescript-eslint/parser.

[JoshuaKGoldberg]

I can't reproduce any issues using the rule in versions 6.5.0 of the parser and plugin. See https://github.com/JoshuaKGoldberg/repros/tree/consistent-type-assertions-type-information.

By the way, if you think there's a bug in typescript-eslint, the right way to ask is to file a new issue. The issue templates include helpful & necessary practices such as making sure you're on the latest version of all our packages. And it's much easier for us as maintainers to not lose track of things posted as issues.

Our contributing guide doesn't explicitly ask not to post tangential questions on closed PRs, so I filed an issue to add those docs. #7586

---

Just to emphasize: if you're experiencing an issue with typescript-eslint, please file an issue with the appropriate template. Please. 🙂