microsoft / microsoft/TypeScript

Ability to type check factory constructed source files

Open
#43,600 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Domain: API Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

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?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the factory createSourceFile entry point alongside the type checker and parser internals described in the issue. Done would mean factory-constructed source files can be passed to the type checker without manually setting parseDiagnostics, bindDiagnostics, identifiers, pragmas, imports, and other internal properties.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.