microsoft / microsoft/TypeScript

Find All References does not report references in mapped types

Offen
#57,115 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Experience Enhancement Help Wanted Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.4k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

🔎 Search Terms
  • find all references mapped type
🕗 Version & Regression Information
  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about (n/a)

TypeScript Version 5.3.3

⏯ Playground Link

https://www.typescriptlang.org/play?#code/KYDwDg9gTgLgBASwHY2FAZgQwMbDgGQVSkwBs4BvAKDlrgGtkATALjgCJSi0z2BuGnQBuZAK7A2SUQFsARmgEBfKqEiw4MAJ5g8AUXBQ4AXgLcSpASvDR4WnXABqCAM5FoAWUxgdTY5UG0ANoA0syISHD6YFCB7IxITOwAuklsABSqUGz6MCTYMAA8UVAANJQMzGyhCXCKAHwAlMZ1cFJyClSKlqo2Gtp4Tq4w0AAiCFDA+X7UdHBcxGTpmWyEC6RNRi1t8lBKVFZq8NikmM7OcACSKGjRwMSe3sC+CNJgpMDSwCjng25QDz5-LMAPTAuCAXg3ACh7cAA4hANPCAErAdBoL64c4QCKcMy8DSYejAc6aCCiBEaAAWLjmyGAZSQEFs8K4SDwAA4AHQBGlrDIGFa49aSGQ7IGzOgTGCiKARTIckSkcQCWbKZQHXrHU7nK7EW7EMYTKYvN4fL4wH4uP4GybwGZ0UEQwD1O7D4cM4MjURMkBi4FiOPMeKR2HBnBSIAB3OAkskwKnnFl4TA1BNwACMACZuQHzHzogK1g1he1DHbxXBJdLZQZ5WJgMq6KqqEA

💻 Code
export interface Literal {
    kind: "literal";
    value: number;
}
export type Expr = Literal;

export type VisitorMapped = {
    [Kind in Expr["kind"]]: (expr: Extract<Expr, { kind: Kind }>) => number;
};

export type VisitorDirect = {
    literal: (expr: Literal) => number;
}

export class InterpreterMapped implements VisitorMapped {
    // 😔 Go to References on "literal" takes you to this line, not to line 8.
    literal(expr: Literal): number {
        return expr.value;
    }
}

export class InterpreterDirect implements VisitorDirect {
    // 💯 Go to References on "literal" show you this line and line 12
    literal(expr: Literal): number {
        return expr.value;
    }
}
🙁 Actual behavior

"Go to References" / "Find All References" has different behaviors for the two literals:

  • for literal in InterpreterDirect it shows two references (in VisitorDirect and InterpreterDirect)
  • for literal in InterpreterMapped it only shows the reference in InterpreterMapped, not in VisitorMapped.
🙂 Expected behavior

I'd expect "Go to References" / "Find All References" to report two references for both of the literals. The mapped type is a reference, even if it doesn't contain the identifier "literal" directly.

Additional information about the issue

This came up with Knip, which uses "find all references" to detect dead code. In this case this behavior caused a false positive: https://github.com/webpro/knip/issues/450

Possibly related to https://github.com/microsoft/TypeScript/issues/44643

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die verknüpfte Playground-Reproduktion auszuführen, und vergleiche Find All References für die gemappten und direkten Visitor-Typen. Da keine Quelldatei oder kein Test genannt ist, verfolge die Implementierung von References ausgehend von diesem Verhalten. Als erledigt gilt die Aufgabe, wenn beide Vorkommen konsistent das Member des gemappten Typs und das direkte Member melden und eine Regression-Abdeckung vorhanden ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
compilers
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.