Skip to content

Feature: [unified-signatures] Option to not report when signature has different JSDoc #10520

Closed
@nicolo-ribaudo

Description

@nicolo-ribaudo

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.4.5&showAST=es&fileType=.tsx&code=FAEwpgxgNghgTmABAMwK4DsIBcCWB7dFACgA8AuRdVAWwCMw4BKCjAa3TwHd0BuYAegBUgxAAFwABwQQYWMCESD%2BicNHhI0mXAWLlEtPHihgY6ZojYdufYMiIBGRnztY4qME%2BBA&eslintrc=N4KABGBEBOCuA2BTAzpAXGUEKQAIBcBPABxQGNoBLY-AWhXkoDt8B6WJygM0sQBNaySgHMmAQ3yxoKdGACM4MAF8QSoA&tsconfig=N4KABGBEDGD2C2AHAlgGwKYCcDyiAuysAdgM6QBcYoEEkJemy0eAcgK6qoDCAFutAGsylBm3TgwAXxCSgA&tokens=false

Repro Code

declare function f(x: number): unknown;
/** @deprecated */ declare function f(x: boolean): unknown;

f(1);
f(true);

ESLint Config

{
  "rules": {
    "@typescript-eslint/unified-signatures": 1
  }
}

tsconfig

No response

Expected Result

It should not warn, because the two signatures cannot be unified. Note that the call f(true) is striked as "deprecated", and it would not be possible for it to happen if the two function declarations were merged into a single one.

Actual Result

It reports

These overloads can be combined into one signature taking number | boolean.

Additional Info

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issueenhancementNew feature or requestlocked due to agePlease open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.package: 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