microsoft / microsoft/TypeScript

improve docs of compiler APIs

Offen
#17,147 7 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Docs
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.4k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

hi,

i'm trying to implement an instrumenter on top of typescript compiler APIs.
i cannot find a "real" documentation beside of this wiki page but i think that it should be upgraded from a single wiki page to a dedicated section with examples for:

  • creating new nodes (e.g. create a brand new statement and attach it to an existing function body)
  • updating existing nodes (e.g. patching a statement)
  • add types declarations (e.g. add arbitrary types to a function declaration)
  • todo...

what do you think about this?

EDIT: i've found this nice article that shows some really useful code.
EDIT: i've found this nice project that can help to understand how to use the compiler apis for more advanced use cases.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der bestehenden Wiki-Seite „Using the Compiler API“ und vergleiche sie mit dem verlinkten Artikel von Scott Logic und dem Projekt ts-simple-ast. Lege den Umfang eines eigenen Abschnitts zur Compiler-API-Dokumentation fest, einschließlich Beispielen zum Erstellen und Aktualisieren von Nodes sowie zum Hinzufügen von Typdeklarationen. Als abgeschlossen gilt die Aufgabe, wenn die vereinbarten API-Themen mit nutzbaren Beispielen dokumentiert sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
compilers, documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.