microsoft / microsoft/TypeScript

Investigate implicit excludes

Abierto
#35,121 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Domain: Performance
Lenguaje dominante
Go
Estrellas
111k
Forks
14.4k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

Today, TypeScript will implicitly set exclude to ./node_modules and something like .*/**/* to avoid dot files.

Unfortunately, there are two problems I believe I've found from chatting with users.

First, users often end up setting exclude which overrides the defaults. This often means that users accidentally over-include files, and that can cause performance issues.

Next, these defaults don't work out well enough, and end up going a bit off the rails in certain scenarios. For example, consider the following .js monorepo.

packages
+- package-aaa
|  +- node_modules    <- the cute tiny 10MB node_modules
|
+- jsconfig.json
+- node_modules        <- the slightly bigger 10GB node_modules
                         shared by each package

Notice that jsconfig.json or not, one of these node_modules is going to be crawled through unless exclude is set appropriately. And regardless of whether exclude is implicitly or explicitly on, it's usually wrong. In this case, it should (probably) be **/node_modules/**/*. For example, check out https://github.com/IBM/report-toolkit/pull/44/files

What I'm suggesting is to harden exclude to always contain the following paths regardless of whether exclude is set.

  • **/node_modules/**/*
  • .*/**

To disable this, users will have to turn off a setting like enableImplicitExcludePatterns.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza reproduciendo el diseño del monorepo .js descrito en el issue y compara el comportamiento con y sin jsconfig.json, así como con un exclude explícito. Investiga cómo el comportamiento actual de exclude implícito maneja tanto las ubicaciones de node_modules como los archivos ocultos. Se considera terminado cuando se haya establecido un enfoque acordado para aplicar o deshabilitar los patrones propuestos.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
compilers
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.