8000 Enhancement: [ban-types] Add `suggest` option to types · Issue #6875 · typescript-eslint/typescript-eslint · GitHub
[go: up one dir, main page]

Skip to content
Enhancement: [ban-types] Add suggest option to types #6875
Closed
@NotWoods

Description

@NotWoods

Before You File a Proposal Please Confirm You Have Done The Following...

My proposal is suitable for this project

  • I believe my proposal would be useful to the broader TypeScript community (meaning it is not a niche proposal).

Link to the rule's documentation

https://typescript-eslint.io/rules/ban-types

Description

Sometimes a banned type can support an autofix, but you'd prefer to pass an array of potential replacements rather than one autofix.

Updating the Types option to:

{
  message: string;
  fixWith?: string;
+ suggest?: readonly string[];
}

would allow for replacements to be show as ESLint suggestions.

This would also allow the default Object and {} banned types to use suggestions.

Fail

function foo(x: {}) {}

Pass

function foo(x: object) {} // replaced by using ESLint suggestion

Additional Info

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issueenhancement: plugin rule optionNew rule option for an existing eslint-plugin rulepackage: eslint-pluginIssues related to @typescript-eslint/eslint-plugin

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0