microsoft / microsoft/TypeScript

The Symbol interface of the compiler is undocumented

オープン
#31,712 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Docs
主要言語
Go
スター
111k
フォーク
14.3k
平均マージ
2日 4時間
マージ済み PR(30日)
132

説明

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.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

src/services/types.ts にあるリンク先の Symbol interface から始め、Using the Compiler API wiki の例およびソース内の API ドキュメントと比較してください。最小限の説明が必要な、コンパイラの中核となる型といくつかの TypeChecker メソッドを特定してください。Symbol interface と選択したメソッドが、Compiler API のユーザーが identifier から declaration へのチェックを理解できる程度に明確にドキュメント化されていれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
compilers, documentation
issue の種類
ドキュメント
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。