microsoft / microsoft/TypeScript

Provide an editor-level warning when including output files

Offen
#40,195 3 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Needs Proposal Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

Something that we noticed with internal codebases, as well as even with RxJS is that tsconfig.jsons are incorrectly configured for editor scenarios and include folders like dist and lib. This means you end up with slower performance, and noisy auto-imports.

We already provide some sort of error here when compiling, but we don't provide the same error in editor scenarios.

Open questions:

  • How is this information presented to the user? How is the editor given notice that it should alert a user about this?
  • What exactly does it mean to include an output file? In the case of RxJS, there are no "output files" getting included in the compilation based on how we determine a file is an an output of input files. Specifically, the root-level tsconfig.json doesn't specify an outDir, so it doesn't know that it should avoid including dist. Maybe we can use some directory-naming heuristics when we find one folder named src and another named dist or lib?

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 mit dem bestehenden Compilerfehler für Projekte, die Ausgabedateien enthalten, und vergleiche, wie dieselbe tsconfig.json in Editorszenarien behandelt wird. Kläre, wie der Editor benachrichtigt werden soll und was als Ausgabedatei gilt, und definiere anschließend das Warnverhalten und die Erkennungsregeln als Abnahmekriterien.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
developer-experience, tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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