fix(eslint-plugin): [consistent-indexed-object-style] fix record mode fixer for generics with a default value #5280

jbalsas · 2022-07-01T06:40:26Z

PR Checklist

Addresses an existing open issue: fixes Bug: [@typescript-eslint/consistent-indexed-object-style] Record mode fixer strips default value for generic #5279
That issue was marked as accepting prs
Steps in CONTRIBUTING.md were taken

Overview

Instead of just mapping each typeParameter node to its name, map it to the complete node text to avoid stripping information.

Before You File a Bug Report Please Confirm You Have Done The Following...

I have tried restarting my IDE and the issue persists.
I have updated to the latest version of the packages.
I have searched for related issues and found none that matched my issue.
I have read the FAQ and my problem is not listed.

Playground Link

https://typescript-eslint.io/play/#ts=4.7.2&sourceType=module&code=JYOwLgpgTgZghgYwgAgGIHt0B4CCyC8ycIAngHzIDeAUMsgNoDWEJAXMgM5hSgDmAuuxwBuagF8gA&eslintrc=N4KABGBEBOCuA2BTAzpAXGUEKQAIBcBPABxQGNoBLY-AWhXkoDt8B6MgeyeUuX0Ra1mAE0QAPRMNocARgCtEZOn0JJ0URNGgdokcGAC+IA0A&tsconfig=N4KABGBEDGD2C2AHAlgGwKYCcDyiAuysAdgM6QBcYoEEkJemy0eAcgK6qoDCAFutAGsylBm3TgwAXxCSgA

Repro Code

interface Foo<A = any> {
  [key: string]: A;
}

Expected Result

type Foo<A = any> = Record<string, A>;

Actual Result

type Foo<A> = Record<string, A>;

nx-cloud · 2022-07-01T06:40:29Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit a93a1e4. 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 47 targets

Sent with 💌 from NxCloud.

typescript-eslint · 2022-07-01T06:40:31Z

Thanks for the PR, @jbalsas!

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. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

netlify · 2022-07-01T06:40:34Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`a93a1e4`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/62be96dd57177500085190b8
😎 Deploy Preview	https://deploy-preview-5280--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 settings.

codecov · 2022-07-01T06:54:41Z

Codecov Report

Merging #5280 (a93a1e4) into main (394425b) will increase coverage by 2.42%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #5280      +/-   ##
==========================================
+ Coverage   91.34%   93.76%   +2.42%     
==========================================
  Files         132      287     +155     
  Lines        1491     9871    +8380     
  Branches      226     2954    +2728     
==========================================
+ Hits         1362     9256    +7894     
- Misses         65      335     +270     
- Partials       64      280     +216

Flag	Coverage Δ
unittest	`93.76% <100.00%> (+2.42%)`	⬆️

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

Impacted Files	Coverage Δ
...lugin/src/rules/consistent-indexed-object-style.ts	`92.06% <100.00%> (ø)`
...es/eslint-plugin/src/rules/no-duplicate-imports.ts	`97.67% <0.00%> (ø)`
...nt-plugin/src/rules/switch-exhaustiveness-check.ts	`97.95% <0.00%> (ø)`
...ackages/eslint-plugin/src/util/getWrappingFixer.ts	`100.00% <0.00%> (ø)`
...ages/eslint-plugin/src/rules/ban-tslint-comment.ts	`100.00% <0.00%> (ø)`
packages/eslint-plugin/src/rules/comma-dangle.ts	`93.33% <0.00%> (ø)`
...ckages/eslint-plugin/src/util/getESLintCoreRule.ts	`75.00% <0.00%> (ø)`
...ages/eslint-plugin/src/rules/prefer-regexp-exec.ts	`100.00% <0.00%> (ø)`
packages/eslint-plugin/src/rules/no-redeclare.ts	`91.89% <0.00%> (ø)`
.../eslint-plugin/src/util/explicitReturnTypeUtils.ts	`96.38% <0.00%> (ø)`
... and 146 more

bradzacher

thanks for fixing this!

jbalsas · 2022-07-04T09:12:25Z

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.30.7` -> `5.31.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.30.7/5.31.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.30.7` -> `5.31.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.30.7/5.31.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)</summary> ### [`v5.31.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5310-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5307v5310-2022-07-25) [Compare Source](typescript-eslint/typescript-eslint@v5.30.7...v5.31.0) ##### Bug Fixes - **eslint-plugin:** \[typedef] Support nested array destructuring with type annotation ([#5311](typescript-eslint/typescript-eslint#5311)) ([6d19efe](typescript-eslint/typescript-eslint@6d19efe)) - **scope-manager:** handle typeParameters of TSInstantiationExpression ([#5355](typescript-eslint/typescript-eslint#5355)) ([2595ccf](typescript-eslint/typescript-eslint@2595ccf)) ##### Features - **eslint-plugin:** \[consistent-generic-ctors] check class field declaration ([#5288](typescript-eslint/typescript-eslint#5288)) ([48f996e](typescript-eslint/typescript-eslint@48f996e)) - **eslint-plugin:** \[prefer-nullish-coalescing] add ignoreTernaryTests option ([#4965](typescript-eslint/typescript-eslint#4965)) ([f82727f](typescript-eslint/typescript-eslint@f82727f)) #### [5.30.7](typescript-eslint/typescript-eslint@v5.30.6...v5.30.7) (2022-07-18) ##### Bug Fixes - **eslint-plugin:** \[no-inferrable] fix optional param to valid code ([#5342](typescript-eslint/typescript-eslint#5342)) ([98f6d5e](typescript-eslint/typescript-eslint@98f6d5e)) - **eslint-plugin:** \[no-unused-vars] highlight last write reference ([#5267](typescript-eslint/typescript-eslint#5267)) ([c3f199a](typescript-eslint/typescript-eslint@c3f199a)) #### [5.30.6](typescript-eslint/typescript-eslint@v5.30.5...v5.30.6) (2022-07-11) **Note:** Version bump only for package [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/eslint-plugin) #### [5.30.5](typescript-eslint/typescript-eslint@v5.30.4...v5.30.5) (2022-07-04) ##### Bug Fixes - **eslint-plugin:** \[consistent-indexed-object-style] fix record mode fixer for generics with a default value ([#5280](typescript-eslint/typescript-eslint#5280)) ([57f032c](typescript-eslint/typescript-eslint@57f032c)) #### [5.30.4](typescript-eslint/typescript-eslint@v5.30.3...v5.30.4) (2022-07-03) **Note:** Version bump only for package [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/eslint-plugin) #### [5.30.3](typescript-eslint/typescript-eslint@v5.30.2...v5.30.3) (2022-07-01) **Note:** Version bump only for package [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/eslint-plugin) #### [5.30.2](typescript-eslint/typescript-eslint@v5.30.1...v5.30.2) (2022-07-01) **Note:** Version bump only for package [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/eslint-plugin) #### [5.30.1](typescript-eslint/typescript-eslint@v5.30.0...v5.30.1) (2022-07-01) ##### Bug Fixes - **eslint-plugin:** \[no-base-to-string] add missing apostrophe to message ([#5270](typescript-eslint/typescript-eslint#5270)) ([d320174](typescript-eslint/typescript-eslint@58034e3)) </details> <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/parser)</summary> ### [`v5.31.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5310-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5307v5310-2022-07-25) [Compare Source](typescript-eslint/typescript-eslint@v5.30.7...v5.31.0) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) #### [5.30.7](typescript-eslint/typescript-eslint@v5.30.6...v5.30.7) (2022-07-18) ##### Bug Fixes - expose types supporting old versions of typescript ([#5339](typescript-eslint/typescript-eslint#5339)) ([4ba9bdb](typescript-eslint/typescript-eslint@4ba9bdb)) #### [5.30.6](typescript-eslint/typescript-eslint@v5.30.5...v5.30.6) (2022-07-11) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) #### [5.30.5](typescript-eslint/typescript-eslint@v5.30.4...v5.30.5) (2022-07-04) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) #### [5.30.4](typescript-eslint/typescript-eslint@v5.30.3...v5.30.4) (2022-07-03) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) #### [5.30.3](typescript-eslint/typescript-eslint@v5.30.2...v5.30.3) (2022-07-01) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) #### [5.30.2](typescript-eslint/typescript-eslint@v5.30.1...v5.30.2) (2022-07-01) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) #### 5.30.1 (2022-07-01) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <[email protected]> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1480 Reviewed-by: Epsilon_02 <[email protected]> Co-authored-by: Calciumdibromid Bot <[email protected]> Co-committed-by: Calciumdibromid Bot <[email protected]>

fix: output complete type parameter for record generics

a93a1e4

bradzacher added the bug Something isn't working label Jul 2, 2022

bradzacher approved these changes Jul 4, 2022

View reviewed changes

bradzacher changed the title ~~fix(eslint-plugin): fixes consistent-indexed-object-style record mode fixer for generics with a default value~~ fix(eslint-plugin): [consistent-indexed-object-style] fix record mode fixer for generics with a default value Jul 4, 2022

bradzacher merged commit 57f032c into typescript-eslint:main Jul 4, 2022

github-actions bot locked as resolved and limited conversation to collaborators Aug 4, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(eslint-plugin): [consistent-indexed-object-style] fix record mode fixer for generics with a default value #5280

fix(eslint-plugin): [consistent-indexed-object-style] fix record mode fixer for generics with a default value #5280

Uh oh!

jbalsas commented Jul 1, 2022 •

edited by bradzacher

Loading

Uh oh!

nx-cloud bot commented Jul 1, 2022 •

edited

Loading

Uh oh!

typescript-eslint bot commented Jul 1, 2022

Uh oh!

netlify bot commented Jul 1, 2022 •

edited

Loading

Uh oh!

codecov bot commented Jul 1, 2022 •

edited

Loading

Uh oh!

bradzacher left a comment

Uh oh!

jbalsas commented Jul 4, 2022

Uh oh!

Uh oh!

Uh oh!

fix(eslint-plugin): [consistent-indexed-object-style] fix record mode fixer for generics with a default value #5280

fix(eslint-plugin): [consistent-indexed-object-style] fix record mode fixer for generics with a default value #5280

Uh oh!

Conversation

jbalsas commented Jul 1, 2022 • edited by bradzacher Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Checklist

Overview

Before You File a Bug Report Please Confirm You Have Done The Following...

Playground Link

Repro Code

Expected Result

Actual Result

Uh oh!

nx-cloud bot commented Jul 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

typescript-eslint bot commented Jul 1, 2022

Uh oh!

netlify bot commented Jul 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for typescript-eslint ready!

Uh oh!

codecov bot commented Jul 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

bradzacher left a comment

Choose a reason for hiding this comment

Uh oh!

jbalsas commented Jul 4, 2022

Uh oh!

Uh oh!

jbalsas commented Jul 1, 2022 •

edited by bradzacher

Loading

nx-cloud bot commented Jul 1, 2022 •

edited

Loading

netlify bot commented Jul 1, 2022 •

edited

Loading

codecov bot commented Jul 1, 2022 •

edited

Loading