microsoft / microsoft/TypeScript
suggest `in` operator when accessing non-common property of union types
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.4k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
🔍 Search Terms
access to non-common property of union types, suggest in operator for union types
✅ Viability Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
⭐ Suggestion
Background: https://twitter.com/kentcdodds/status/1420125238436655104?s=21
When accessing props that are not on all union types, tsc gives Property 'foo' does not exist on type 'XX', which is confusing to newcomers. We can suggest the in operator when it is used inside if condition.
📃 Motivating Example
type A = {one: string}
type B = {two: string}
type C = A | B
declare const thing: C
// 😕Before:
// Property 'two' does not exist on type 'C'.
// Property 'two' does not exist on type 'A'.(2339)
if (thing.two) {
// it's a B
}
// 😄After:
// Property 'two' does not exist on type 'C'.
// Property 'two' does not exist on type 'A'.(2339)
// Did you mean to use `'two' in thing`?
if (thing.two) {
// it's a B
}
💻 Use Cases
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die Implementierung und Tests des TypeScript-Compilers für Diagnose 2339 und verwandte Vorschlagsdiagnosen zu finden. Bestätige das Verhalten beim Property-Zugriff innerhalb einer if-Bedingung, füge dann den vorgeschlagenen in-Operator-Vorschlag mit Tests für Union-Typen hinzu und überprüfe die Formulierung der Diagnose.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- compilers
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100