Skip to content

Rule proposal: disallow default values for fields that are never undefined #11405

@donaldpipowitch

Description

@donaldpipowitch

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

My proposal is suitable for this project

  • My proposal specifically checks TypeScript syntax, or it proposes a check that requires type information to be accurate.
  • My proposal is not a "formatting rule"; meaning it does not just enforce how code is formatted (whitespace, brace placement, etc).
  • I believe my proposal would be useful to the broader TypeScript community (meaning it is not a niche proposal).

Description

During refactorings I sometimes encounter orphaned default values. This is dead code that creates noise and for complex type definitions they are hard to identify. I'm not aware of any rule or TypeScript setting that handles this.

Fail Cases

function example({ hello = 'world'}: { hello: string }) {}

The default value 'world' would never be used as you can never call this function without providing a value for hello.

Pass Cases

function example({ hello }: { hello: string }) {}

Additional Info

I'd be happy to contribute this rule if I'm allowed to. ❤️

Metadata

Metadata

Assignees

No one assigned

    Labels

    duplicateThis issue or pull request already existsenhancement: new plugin ruleNew rule request for eslint-pluginpackage: 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