microsoft / microsoft/TypeScript

Allow to Override Import Paths For Auto-Import

Offen
#45,065 2 Kommentare 5 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Awaiting More Feedback Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.4k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

IDisposable, Emitter and Event are very common types in the VS Code codebase.
Unfortunately, you have to be very careful when importing them through autocomplete.
Even worse, sometimes all the places to import from are suggested except the correct one.

In 99% of cases, we are importing IDisposable from vs/base/common/lifecycle. As you can see here, TypeScripts suggests all places except the right one:

image

It would be very practical if one could override where to import unresolved symbols from.
E.g.

"typescript.importFromOverrides": {
  "src/vs/editor/**": {
    "IDisposable": "vs/base/common/lifecycle",
    "Event": "vs/base/common/events"
  }
}

Alternatively, TypeScript could figure out where the Symbol has been imported from in adjacent files.
Maybe a disallow-list would also make sense (never import IDisposable from node-pty, or never import anything from vs/workbench/workbench.web.api).

This is now the second codebase where I ran into the permanent problem of importing a common symbol from a wrong module, which makes me believe this is a common problem.
I run into this problem one to ten times per day.

Here is another example:
image
We never want to import from vscode.
Being able to customize the preferred import would be a huge deal (especially for the quickfix "add all missing imports").

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

Das gemeldete Verhalten von Auto-Import und Quick-Fix in der VS Code-Codebasis mit Symbolen wie IDisposable, Emitter und Event reproduzieren. Die vorgeschlagenen Module mit den bevorzugten Importpfaden in den Beispielen vergleichen; abgeschlossen bedeutet, dass das angeforderte Verhalten für Importpräferenzen oder Ausschlüsse unterstützt wird und beim Hinzufügen fehlender Importe funktioniert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript, vscode
Bereich
developer-experience, tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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