microsoft / microsoft/TypeScript
'utilities.ts' is an API surface hazard
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 132
Beschreibung
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.tspublicUtilities.tspublicPredicates.ts- I don't know, TBD.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Lesen von utilities.ts und katalogisiere die vier Namespaces. Notiere dabei, welche Funktionen intern, exponiert oder Typprädikate sind. Lege für jede Gruppe ein konsistentes Ziel fest, einschließlich des derzeit noch ungeklärten gemischten Namespaces. Als abgeschlossen gilt die Aufgabe, wenn die Organisation der Utilities und die Grenzen ihrer Exponierung klar und konsistent angewendet sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- compilers
- Issue-Typ
- Refactoring
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100