microsoft / microsoft/TypeScript

The Symbol interface of the compiler is undocumented

Aperta
#31,712 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Docs
Lingua principale
Go
Stelle
111k
Fork
14.4k
Merge medio
1g 19h
PR unite (30g)
117

Descrizione

TypeScript Version: master

Search Terms: Symbol interface compiler

Code

https://github.com/microsoft/TypeScript/blob/15daf42b2c0bc4f06970c9e4688f1a93bff0f7a0/src/services/types.ts#L31

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.

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 dall'interfaccia Symbol collegata in src/services/types.ts, quindi confrontala con gli esempi della wiki Using the Compiler API e con la documentazione dell'API nel codice sorgente. Individua i tipi fondamentali del compilatore e alcuni metodi di TypeChecker che necessitano di spiegazioni minime. Il lavoro è completato quando l'interfaccia Symbol e i metodi selezionati sono documentati in modo sufficientemente chiaro da permettere agli utenti della Compiler API di comprendere i controlli da identifier a declaration.

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

Valutazione

Stack tecnologico
typescript
Ambito
compilers, documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
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.