microsoft / microsoft/TypeScript

Provide an editor-level warning when including output files

Ouverte
#40,195 3 commentaires 2 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Needs Proposal Suggestion
Langage dominant
Go
Étoiles
111k
Forks
14.4k
Merge moyen
1 j 19 h
PR mergées (30 j)
117

Description

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?

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par l’erreur existante du compilateur pour les projets qui incluent des fichiers de sortie et comparez la manière dont le même tsconfig.json est traité dans les scénarios de l’éditeur. Clarifiez la manière dont l’éditeur doit être informé et ce qui constitue un fichier de sortie, puis définissez le comportement de l’avertissement et les règles de détection comme critères de réalisation.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
typescript
Domaine
developer-experience, tooling
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.