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

dora1998 · 2023-04-11T15:52:21Z

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 · 2023-04-11T15:52:24Z

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 · 2023-04-11T15:52:30Z

✅ 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 · 2023-04-11T15:56:29Z

☁️ 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

Sent with 💌 from NxCloud.

codecov · 2023-04-11T16:12:41Z

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%> (ø)`

…alue with parentheses

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!

packages/eslint-plugin/src/rules/consistent-type-assertions.ts

packages/eslint-plugin/src/util/getWrappingFixer.ts

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.

packages/eslint-plugin/src/util/getWrappingFixer.ts

JoshuaKGoldberg · 2023-07-16T23:45:17Z

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 · 2023-07-23T17:19:49Z

@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 · 2023-07-26T13:01:59Z

packages/eslint-plugin/src/rules/consistent-type-assertions.ts

@@ -1,7 +1,10 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { isBinaryExpression, isNewExpression } from 'tsutils';


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

JoshuaKGoldberg · 2023-08-15T18:38:45Z

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 · 2023-08-26T11:41:26Z

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

JoshuaKGoldberg

Swell, thanks for such a thorough change! 🙌

alecmev · 2023-08-30T14:54:36Z

Does this not make consistent-type-assertions typed?

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`6.4.1` -> `6.5.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/6.4.1/6.5.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`6.4.1` -> `6.5.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/6.4.1/6.5.0) | | [@typescript-eslint/typescript-estree](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`6.4.1` -> `6.5.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2ftypescript-estree/6.4.1/6.5.0) | | [netlify-cli](https://github.com/netlify/cli) | devDependencies | minor | [`16.1.0` -> `16.2.0`](https://renovatebot.com/diffs/npm/netlify-cli/16.1.0/16.2.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)</summary> ### [`v6.5.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#650-2023-08-28) [Compare Source](typescript-eslint/typescript-eslint@v6.4.1...v6.5.0) ##### Bug Fixes - **eslint-plugin:** \[consistent-type-assertions] wrap object return value with parentheses ([#6885](typescript-eslint/typescript-eslint#6885)) ([23ac499](typescript-eslint/typescript-eslint@23ac499)) 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. #### [6.4.1](typescript-eslint/typescript-eslint@v6.4.0...v6.4.1) (2023-08-21) ##### Bug Fixes - **eslint-plugin:** \[no-unnecessary-condition] false positives with branded types ([#7466](typescript-eslint/typescript-eslint#7466)) ([b52658f](typescript-eslint/typescript-eslint@b52658f)), closes [#7293](typescript-eslint/typescript-eslint#7293) 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. </details> <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/parser)</summary> ### [`v6.5.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#650-2023-08-28) [Compare Source](typescript-eslint/typescript-eslint@v6.4.1...v6.5.0) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) 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. #### [6.4.1](typescript-eslint/typescript-eslint@v6.4.0...v6.4.1) (2023-08-21) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) 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. </details> <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/typescript-estree)</summary> ### [`v6.5.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/typescript-estree/CHANGELOG.md#650-2023-08-28) [Compare Source](typescript-eslint/typescript-eslint@v6.4.1...v6.5.0) ##### Features - bump supported TS version to 5.2 ([#7535](typescript-eslint/typescript-eslint#7535)) ([f18c88d](typescript-eslint/typescript-eslint@f18c88d)) - support Explicit Resource Management syntax for TS 5.2 ([#7479](typescript-eslint/typescript-eslint#7479)) ([c11e05c](typescript-eslint/typescript-eslint@c11e05c)) 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. #### [6.4.1](typescript-eslint/typescript-eslint@v6.4.0...v6.4.1) (2023-08-21) **Note:** Version bump only for package [@typescript-eslint/typescript-estree](https://github.com/typescript-eslint/typescript-estree) 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. </details> <details> <summary>netlify/cli (netlify-cli)</summary> ### [`v16.2.0`](https://github.com/netlify/cli/blob/HEAD/CHANGELOG.md#1620-2023-08-29) [Compare Source](netlify/cli@v16.1.0...v16.2.0) ##### Features - add support for `context.params` in edge functions ([#5964](netlify/cli#5964)) ([ed14e05](netlify/cli@ed14e05)) - support custom function routes ([#5954](netlify/cli#5954)) ([82b94b5](netlify/cli@82b94b5)) ##### Bug Fixes - **deps:** update dependency [@netlify/edge-bundler](https://github.com/netlify/edge-bundler) to v8.18.0 ([#5953](netlify/cli#5953)) ([016cdf9](netlify/cli@016cdf9)) - **deps:** update dependency [@netlify/edge-bundler](https://github.com/netlify/edge-bundler) to v8.19.0 ([#5971](netlify/cli#5971)) ([42478fd](netlify/cli@42478fd)) - **deps:** update dependency [@netlify/serverless-functions-api](https://github.com/netlify/serverless-functions-api) to v1.6.0 ([#5935](netlify/cli#5935)) ([1d68354](netlify/cli@1d68354)) - **deps:** update dependency [@netlify/serverless-functions-api](https://github.com/netlify/serverless-functions-api) to v1.7.3 ([#5957](netlify/cli#5957)) ([57d6627](netlify/cli@57d6627)) - **deps:** update dependency lambda-local to v2.1.2 ([#5967](netlify/cli#5967)) ([e592944](netlify/cli@e592944)) - **deps:** update netlify packages ([#5915](netlify/cli#5915)) ([1ad27ac](netlify/cli@1ad27ac)) - **deps:** update netlify packages ([#5965](netlify/cli#5965)) ([654c366](netlify/cli@654c366)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 3pm on Sunday" in timezone America/New_York, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.chriswb.dev/chrisw-b/PersonalApi/pulls/3 Reviewed-by: chrisw-b <chrisw-b@noreply.localhost> Co-authored-by: Renovate Bot <renovate.bot@chrisb.xyz> Co-committed-by: Renovate Bot <renovate.bot@chrisb.xyz>

polyzen · 2023-08-31T23:05:48Z

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 · 2023-08-31T23:23:19Z

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

typescript-eslint/typescript-eslint#6885 (comment)

dora1998 force-pushed the fix-consistent-type-assertion-fixer branch from bf78617 to d2b2a32 Compare April 11, 2023 15:57

fix(eslint-plugin): [consistent-type-assertions] wrap object return v…

8b43da5

…alue with parentheses

dora1998 force-pushed the fix-consistent-type-assertion-fixer branch from d2b2a32 to 8b43da5 Compare April 11, 2023 17:13

dora1998 changed the title ~~fix(eslint-plugin): [consistent-type-assertions] wrap object type assertion with parentheses~~ fix(eslint-plugin): [consistent-type-assertions] wrap object return value with parentheses Apr 11, 2023

dora1998 marked this pull request as ready for review April 11, 2023 17:56

JoshuaKGoldberg requested changes Apr 11, 2023

View reviewed changes

packages/eslint-plugin/src/rules/consistent-type-assertions.ts Outdated Show resolved Hide resolved

JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Apr 11, 2023

dora1998 added 2 commits April 14, 2023 02:44

use getWrappingFixer

c72d3c2

fix

2662e6e

dora1998 requested a review from JoshuaKGoldberg April 13, 2023 18:40

JoshuaKGoldberg reviewed Apr 13, 2023

View reviewed changes

packages/eslint-plugin/src/util/getWrappingFixer.ts Outdated Show resolved Hide resolved

JoshuaKGoldberg previously approved these changes Apr 13, 2023

View reviewed changes

JoshuaKGoldberg added 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge and removed awaiting response Issues waiting for a reply from the OP or another party labels Apr 13, 2023

JoshuaKGoldberg reviewed Apr 13, 2023

View reviewed changes

packages/eslint-plugin/src/util/getWrappingFixer.ts Outdated Show resolved Hide resolved

fix

620311f

dora1998 dismissed JoshuaKGoldberg’s stale review via 620311f April 14, 2023 00:19

fix

5862985

dora1998 requested a review from JoshuaKGoldberg April 14, 2023 01:12

bradzacher added the bug Something isn't working label Apr 14, 2023

armano2 reviewed Apr 14, 2023

View reviewed changes

packages/eslint-plugin/src/util/getWrappingFixer.ts Outdated Show resolved Hide resolved

fix

02ada97

dora1998 requested a review from armano2 April 15, 2023 07:58

JoshuaKGoldberg mentioned this pull request May 12, 2023

fix(eslint-plugin): [no-extra-parens] false positive when used with satisfies keyword #7026

Closed

3 tasks

bradzacher reviewed Jul 17, 2023

View reviewed changes

dora1998 added 2 commits July 24, 2023 01:26

update getOperatorPrecedence

00771e7

use precedence to wrap node in parens

2d10a7f

JoshuaKGoldberg reviewed Jul 26, 2023

View reviewed changes

JoshuaKGoldberg removed the awaiting response Issues waiting for a reply from the OP or another party label Aug 5, 2023

JoshuaKGoldberg added 4 commits August 15, 2023 14:39

Merge branch 'main' into fix-consistent-type-assertion-fixer

35c71f7

Fix up post-merge

0552295

lint --fix

0599935

remove comment

0e2277d

JoshuaKGoldberg previously approved these changes Aug 15, 2023

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 Aug 15, 2023

armano2 removed their request for review August 19, 2023 13:14

JoshuaKGoldberg added 2 commits August 26, 2023 15:01

Merge branch 'main' into fix-consistent-type-assertion-fixer

f301006

Remove post-merge artifact

6948bfd

JoshuaKGoldberg dismissed their stale review via 6948bfd August 26, 2023 19:04

JoshuaKGoldberg approved these changes Aug 27, 2023

View reviewed changes

JoshuaKGoldberg merged commit 23ac499 into typescript-eslint:main Aug 27, 2023
46 of 48 checks passed

dora1998 deleted the fix-consistent-type-assertion-fixer branch August 27, 2023 09:48

JoshuaKGoldberg mentioned this pull request Aug 31, 2023

Docs: Ask not to post followup questions on merged PRs #7586

Closed

2 tasks

archlinux-github pushed a commit to archlinux/neoasknot that referenced this pull request Aug 31, 2023

Downgrade typescript-eslint to 6.4.1

3c4dc21

typescript-eslint/typescript-eslint#6885 (comment)

github-actions bot locked as resolved and limited conversation to collaborators Sep 8, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

dora1998 commented Apr 11, 2023 •

edited

Loading

typescript-eslint bot commented Apr 11, 2023

netlify bot commented Apr 11, 2023 •

edited

Loading

nx-cloud bot commented Apr 11, 2023 •

edited

Loading

codecov bot commented Apr 11, 2023 •

edited

Loading

JoshuaKGoldberg left a comment

JoshuaKGoldberg left a comment

JoshuaKGoldberg commented Jul 16, 2023

bradzacher left a comment

dora1998 commented Jul 23, 2023 •

edited

Loading

JoshuaKGoldberg Jul 26, 2023

JoshuaKGoldberg commented Aug 15, 2023

JoshuaKGoldberg left a comment

dora1998 commented Aug 26, 2023

JoshuaKGoldberg left a comment

alecmev commented Aug 30, 2023

polyzen commented Aug 31, 2023

JoshuaKGoldberg commented Aug 31, 2023 •

edited

Loading

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

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

Conversation

dora1998 commented Apr 11, 2023 • edited Loading

PR Checklist

Overview

typescript-eslint bot commented Apr 11, 2023

netlify bot commented Apr 11, 2023 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

nx-cloud bot commented Apr 11, 2023 • edited Loading

☁️ Nx Cloud Report

codecov bot commented Apr 11, 2023 • edited Loading

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg commented Jul 16, 2023

bradzacher left a comment

Choose a reason for hiding this comment

dora1998 commented Jul 23, 2023 • edited Loading

JoshuaKGoldberg Jul 26, 2023

Choose a reason for hiding this comment

JoshuaKGoldberg commented Aug 15, 2023

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

dora1998 commented Aug 26, 2023

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

alecmev commented Aug 30, 2023

polyzen commented Aug 31, 2023

JoshuaKGoldberg commented Aug 31, 2023 • edited Loading

dora1998 commented Apr 11, 2023 •

edited

Loading

netlify bot commented Apr 11, 2023 •

edited

Loading

nx-cloud bot commented Apr 11, 2023 •

edited

Loading

codecov bot commented Apr 11, 2023 •

edited

Loading

dora1998 commented Jul 23, 2023 •

edited

Loading

JoshuaKGoldberg commented Aug 31, 2023 •

edited

Loading