microsoft / microsoft/TypeScript

'utilities.ts' is an API surface hazard

Aperta
#21,258 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Infrastructure
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia leggendo utilities.ts e cataloga i quattro namespace, annotando quali funzioni sono interne, esposte o predicati di tipo. Definisci una destinazione coerente per ogni gruppo, incluso il namespace misto attualmente irrisolto. Il lavoro è completato quando l'organizzazione delle utility e i confini di esposizione sono chiari e applicati in modo coerente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
compilers
Tipo di issue
Refactoring
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.