microsoft / microsoft/TypeScript
improve docs of compiler APIs
まだ誰も着手していません。
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
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.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
既存の “Using the Compiler API” wiki ページから始め、リンクされている Scott Logic の記事および ts-simple-ast プロジェクトと比較します。ノードの作成と更新、型宣言の追加の例を含む、Compiler API 専用ドキュメントセクションの範囲を定義します。合意した API のトピックが利用可能な例とともに文書化されれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- compilers, documentation
- issue の種類
- ドキュメント
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100