Expose MappedType in typescript.d.ts

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

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

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
typescript
領域
compilers

調査の方向性

src/compiler/types.ts の内部 MappedType インターフェイス付近から始め、現在のフィールドを要求されたパブリック API と比較します。リンクされている typescript-eslint ルールの例を確認し、利用側のニーズを理解します。MappedType が typescript.d.ts を通じて公開され、要求された typeParameter、constraintType、templateType へのアクセスが提供されれば完了です。

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

説明

In Discussion Suggestion
🔍 Search Terms

mappedtype interface typeParameter constraintType templateType

✅ Viability Checklist
⭐ Suggestion

Coming over from typescript-eslint, we need to look at the properties on mapped types for the @typescript-eslint/no-unnecessary-type-parameters ("Golden Rule of Generics") rule. But, MappedType is marked as @internal in TypeScript's definition:

https://github.com/microsoft/TypeScript/blob/22bbe867fd4b86e2187270f6c284e6cfd92a3fea/src/compiler/types.ts#L6584-L6594

Could we have that interface be public, please? Even if all the fields other than constraintType, templateType, and typeParameter are switched to @internal. I don't know of a more sanctioned way to access those type properties. Is there one?

📃 Motivating Example

Marking MappedType as public would provide a way for type checker API consumers to reason about mapped types.

💻 Use Cases

See https://github.com/typescript-eslint/typescript-eslint/pull/8173 & https://github.com/typescript-eslint/typescript-eslint/pull/9530: in typescript-eslint, we need to access a few properties of mapped types to check if they're uses of a type parameter. We ended up writing our own interface MappedType extends ts.ObjectType:

interface MappedType extends ts.ObjectType {
  typeParameter?: ts.Type; // #8173
  constraintType?: ts.Type; // #9530
  templateType?: ts.Type; // #9530
}
主要言語
Go
スター
111k
フォーク
14.4k
平均マージ
1日 19時間
マージ済み PR(30日)
117

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

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

はじめの一歩

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

microsoft/TypeScript のほかの issue

microsoft/TypeScript の issue をすべて見る

似ている issue

Go の issue をもっと見る

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

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