microsoft / microsoft/TypeScript

Add support for beforeDeclarations

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

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

Awaiting More Feedback Suggestion
主要言語
Go
スター
111k
フォーク
14.4k
平均マージ
1日 19時間
マージ済み PR(30日)
117

説明

🔍 Search Terms

beforeDeclarations declaration transform transformers afterDeclarations

✅ Viability Checklist
⭐ Suggestion

The TypeScript compiler API already supports custom transformers in 3 ways:

  1. Before built-in .js transformations
  2. After built-in .js transformations
  3. After built-in .d.ts transformations

But the API is missing a "Before built-in .d.ts transformations" variant.

📃 Motivating Example

To generate type declarations more dynamically, you often need to access AST nodes of your codebase as it is written. The built-in transformers erase already a lot of the AST making this information unavailable. With the help of this new beforeDeclarations you are able to access your full AST and use it to auto-generate your typescript declaration files.

💻 Use Cases
  1. Use information from property initializers to include "default values" your JSDoc comments. (see #41486).
  2. Remove declarations using information like visibility modifiers or used functions in your code to not expose implementation details.

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

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

はじめの一歩

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

調査の方向性

まず、TypeScript compiler API に既に存在するカスタム transformer のバリエーション、特に issue で説明されている宣言変換の before および after ステージを確認します。それらの公開 API の形状を比較し、beforeDeclarations ステージがどのように適合するかを判断します。カスタム transformer が宣言生成のために変換前の AST にアクセスでき、動機となったユースケースがサポートされれば完了です。

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

評価

技術スタック
typescript
領域
compilers
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
25/100

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

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