microsoft / microsoft/TypeScript
The Symbol interface of the compiler is undocumented
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.4k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
TypeScript Version: master
Search Terms: Symbol interface compiler
Code
The "Using the Compiler API" docs have examples which use Symbols, but they don't say what they are and neither do the API docs in the source.
It'd be incredibly helpful if the core compiler types were at least minimally documented, along with a few of the TypeChecker methods.
Context:
I'm trying to use the compiler API for linting and want to verify that an identifier references a particular declaration.
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
Beginnen Sie mit dem verlinkten Symbol interface in src/services/types.ts und vergleichen Sie es anschließend mit den Beispielen im Wiki Using the Compiler API sowie mit der API-Dokumentation im Quellcode. Identifizieren Sie die zentralen Compiler-Typen und einige TypeChecker-Methoden, die minimale Erklärungen benötigen. Als abgeschlossen gilt die Aufgabe, wenn das Symbol interface und die ausgewählten Methoden so klar dokumentiert sind, dass Benutzer der Compiler API Prüfungen von Identifier zu Declaration verstehen können.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- compilers, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100