microsoft / microsoft/TypeScript

Ability to type check factory constructed source files

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

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

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

説明

Suggestion

It would be nice to have the ability to type check factory constructed source files.

For example, say I create some ASTs like so, where params.module.body is some foreign AST that I'm converting to a tsc AST:

const sourceFile = ts.factory.createSourceFile(
    params.module.body.map(item => convertModuleItem(item)),
    ts.factory.createToken(ts.SyntaxKind.EndOfFileToken), // side note... i'm unsure why this param exists
    ts.NodeFlags.None,
);
sourceFile.fileName = params.fileName;
sourceFile.text = params.fileText;
setRange(sourceFile, params.module); // my own function that sets the range

...it would be better to be able to use these source files without having to implement all the necessary hacks. For example, not having to do...

(sourceFile as any).parseDiagnostics = [];
(sourceFile as any).bindDiagnostics = [];

...along with figuring out how to set many more internal properties (ex. identifiers, pragmas, imports, etc... etc...).

🔍 Search Terms

type check transformed AST source file

✅ Viability Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

💻 Use Cases

  • Ability to do AST transformations then feed that back through the type checker without having to print out the AST to a string then reparsing that string to an AST using the TS compiler.
  • Ability to take a non-tsc AST representation of an AST and construct it to a tsc AST using the factory methods. This would be useful in Deno as it is already parsing an AST with swc and so it could pass that AST over to the TS compiler for type checking.

Viability?

I understand this is a huge ask and the main reason I'm opening this is to ask how viable it is?

I believe the type checker would need to be changed to sparingly consult the source file text or node ranges and some of the code in the parser that sets internal properties would need to be extracted out to support it being lazily computed in addition to when it's parsed. Additionally, factory methods would have to clear the appropriate internal properties on nodes when they're transformed so that they will be lazily computed in the future when the type checker goes to retrieve them. Anything else?

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

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

はじめの一歩

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

調査の方向性

まず、issue で説明されている type checker と parser の内部実装と併せて、factory createSourceFile エントリポイントを読みます。factory で構築された source file を、parseDiagnostics、bindDiagnostics、identifiers、pragmas、imports、その他の内部プロパティを手動で設定せずに type checker に渡せるようになれば完了です。

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

評価

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

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

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