microsoft / microsoft/TypeScript
improve docs of compiler APIs
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.4k
- Merge moyen
- 1 j 19 h
- PR mergées (30 j)
- 117
Description
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencer par la page wiki existante « Using the Compiler API » et la comparer avec l’article de Scott Logic indiqué et le projet ts-simple-ast. Définir le périmètre d’une section dédiée à la documentation de la Compiler API, notamment avec des exemples de création et de mise à jour de nœuds et d’ajout de déclarations de types. Le travail est considéré comme terminé lorsque les sujets d’API convenus sont documentés avec des exemples utilisables.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- compilers, documentation
- Type d'issue
- Documentation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100