Skip to content

Bug: [consistent-indexed-object-style] auto-fixer generates invalid syntax for TSMappedType with no type annotation #11179

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

Closed
4 tasks done
ronami opened this issue May 6, 2025 · 1 comment · Fixed by #11180
Labels
accepting prs Go ahead, send a pull request that resolves this issue bug Something isn't working locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing. package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin

Comments

@ronami
Copy link
Member

ronami commented May 6, 2025

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=5.8.3&fileType=.tsx&code=C4TwDgpgBAQghgJygXigbwFBSgbQNZQCWAdlAM7AIkDmAugNwYC%2BjQA&eslintrc=N4KABGBEBOCuA2BTAzpAXGUEKQAIBcBPABxQGNoBLY-AWhXkoDt8B6MgeyeUuX0Ra1mAE0QAPRMNocARgCtEZOn0JJ0URNGgdokcGAC%2BIA0A&tsconfig=N4KABGBEDGD2C2AHAlgGwKYCcDyiAuysAdgM6QBcYoEEkJemy0eAcgK6qoDCAFutAGsylBm3TgwAXxCSgA&tokens=false

Repro Code

// the following seems to be valid syntax and is parsable:
type Bar = {
  [k in string];
};

// it gets auto-fixed into the following syntax error
type Bar = Record<string, type Bar = {
  [k in string];
};
>;

ESLint Config

module.exports = {
  parser: "@typescript-eslint/parser",
  rules: {
    "@typescript-eslint/consistent-indexed-object-style": "error",
  },
};

tsconfig

{
  "compilerOptions": {
    "strictNullChecks": true
  }
}

Expected Result

I expected the rule to either not have an auto-fix for this special-case, or auto-fix it into the following Record:

type Bar = Record<string, any>;

Actual Result

The rule auto-fixes this into invalid syntax:

type Bar = Record<string, type Bar = {
  [k in string];
};
>;

Additional Info

TSMappedType‘s type annotation can be undefined (source).

I noticed this while trying to add missing coverage in #11177.

@ronami ronami added bug Something isn't working package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin triage Waiting for team members to take a look labels May 6, 2025
@ronami ronami changed the title Bug: [consistent-indexed-object-style] auto-fixer generates invalid syntax for TSMappedType with no type annotation Bug: [consistent-indexed-object-style] auto-fixer generates invalid syntax for TSMappedType with no type annotation May 6, 2025
@bradzacher
Copy link
Member

it's worth noting that this is valid syntax, but it is invalid under noImplicitAny.
That being said -- we shouldn't break code.

@bradzacher bradzacher added accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for team members to take a look labels May 6, 2025
@github-actions github-actions bot added the locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing. label May 20, 2025
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 20, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepting prs Go ahead, send a pull request that resolves this issue bug Something isn't working locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing. package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin
Projects
None yet
2 participants