Skip to content

Enhancement: [ban-types] ban certain types to be extended from #7127

Closed
@Haberkamp

Description

@Haberkamp

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

I think that it would be useful to ban certain types from being extended. The job of the rule is to ban the usage of certain types and provide an alternative way if possible. Creating a new interface and extending from a harmful/confusing type also will introduce the usage of that not wanted type.

One use case might be to eliminate the usage of HTMLProps and HTMLAttributes.

Fail

interface Props extends from HTMLProps<HTMLButtonElement> {}

Pass

interface Props extends from ComponentPropsWithoutRef<'div>' {}

Additional Info

Link to the resource on why HTMLProps and HTMLAttributes can be problematic: https://react-typescript-cheatsheet.netlify.app/docs/advanced/patterns_by_usecase/#wrappingmirroring-a-html-element

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