microsoft / microsoft/TypeScript

improve docs of compiler APIs

Aperta
#17,147 7 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

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

Descrizione

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.

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 dalla pagina wiki esistente “Using the Compiler API” e confrontala con l’articolo di Scott Logic collegato e con il progetto ts-simple-ast. Definisci l’ambito di una sezione dedicata alla documentazione della Compiler API, includendo esempi per la creazione e l’aggiornamento dei nodi e per l’aggiunta di dichiarazioni di tipo. Il lavoro è completato quando gli argomenti dell’API concordati sono documentati con esempi utilizzabili.

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

Valutazione

Stack tecnologico
typescript
Ambito
compilers, documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.