microsoft / microsoft/TypeScript

'utilities.ts' is an API surface hazard

Abierto
#21,258 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Infrastructure
Lenguaje dominante
Go
Estrellas
111k
Forks
14.3k
Merge medio
2 d 4 h
PR fusionados (30 d)
132

Descripción

utilities.ts consists of 4 different namespaces:

  • one which seems to be entirely internal
  • one which is entirely exposed
  • one which is entirely exposed and is entirely type predicate functions
  • one which is a random assortment of internal and exposed functions that have no consistent usage

Just from my intuition and experience, I don't think this is a good idea. It's just too easy to put a new helper in some random section of the file and forget whether or not it's being exposed.

As a naive first approximation, here's what I think would be more appropriate for each respective namespace:

  • utilities.ts
  • publicUtilities.ts
  • publicPredicates.ts
  • I don't know, TBD.

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

Empieza leyendo utilities.ts y cataloga los cuatro namespaces, indicando qué funciones son internas, están expuestas o son predicados de tipo. Define un destino coherente para cada grupo, incluido el namespace mixto que aún no se ha resuelto. Se considera terminado cuando la organización de las utilidades y los límites de exposición están claros y se aplican de forma coherente.

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

Evaluación

Stack tecnológico
typescript
Área
compilers
Tipo de issue
Refactorización
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.