microsoft / microsoft/TypeScript
Have QuickInfo use import types to display type aliases that are not in scope
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 132
Beschreibung
Search Terms:
type alias, import, display, quickinfo, intellisense
Code
// @Filename: file1.ts
export type ComplicatedType<T, U> = { [K in Exclude<keyof T, U>]: T[K] } // could be anything here
export declare function getComplicatedType<T, U extends keyof T>(arg: T, exclude: U): ComplicatedType<T, U>
// @Filename: file2.ts
import { getComplicatedType } from "./file1"
interface SomeInterface {
a: string
b<T>(arg: T): T,
c: { c2: string } | { c3: number },
d?: boolean
}
declare const test: SomeInterface
const result = getComplicatedType(test, "a") // quickinfo on result currently displays something like:
/* const result: {
b: <T>(arg: T) => T;
c: {
c2: string;
} | {
c3: number;
};
d: boolean | undefined;
} */
Current behavior:
The quick info type shown for result is a fully expanded anonymous type because ComplicatedType is not in scope in file2. Importing ComplicatedType in file2 makes quick info display const result: ComplicatedType<SomeInterface, "a">, but I don't think it's common to import a type alias purely for the quick info benefit if it isn't actually used anywhere in the file.
While the example above isn't that bad, in some cases (#18754, #23458) the fully expanded types can be so large that they actually cause a performance issue for the language service.
Suggested behavior:
Use import types from #22592 to display an accurate qualified reference to ComplicatedType. So in the example above quick info for result could instead display something like:
const result: import("./file1").ComplicatedType<SomeInterface, "a">
Which, although a little verbose, would be much more readable than many fully expanded types.
Related Issues:
#22592 added import types.
#18754, #23458, #6070, #13095 - Various issues related to the display of types.
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 mit der file1.ts/file2.ts-Reproduktion und dem im Issue beschriebenen QuickInfo-Verhalten; prüfe Importtypen aus Issue #22592 und die zugehörigen Type-Display-Issues. Erledigt ist es, wenn QuickInfo eine qualifizierte Import-Type-Referenz wie import("./file1").ComplicatedType<SomeInterface, "a"> anzeigen kann, statt den Alias zu expandieren.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100