Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor type generation scripts #2379

Merged
merged 9 commits into from
Jul 12, 2024
Merged

Refactor type generation scripts #2379

merged 9 commits into from
Jul 12, 2024

Conversation

penalosa
Copy link
Collaborator

@penalosa penalosa commented Jul 11, 2024

This is the first part of landing Types as a Service.

This is a relatively large PR, but it's pretty low risk. It mostly contains some refactoring of the type generation code (e.g. files like types/src/transforms/overrides/compiler.ts which have not changed in functionality). In large part this refactoring is to make it easier for a future PR (another part of #1959) to run this code in a Worker (for instance, changing import ... from "assert" to import ... from "node:assert" is in support of this goal, as well as the enhancing of the memory-based compiler host we use for running TypeScript).

This PR changes the output of the generated index.d.ts files to no longer declare things for which that's not necessary. This is semantically the same thing, and should have no impact on the usage of these types. We probably should've done it like this all along:

- declare interface SomeInterface {}
+ interface SomeInterface {}

- declare type SomeType =  {}
+ type SomeType = {}

However, this has resulted in some test changes—the behaviour is otherwise unchanged, and the output after this PR should be the same as the output before.

This PR doesn't cover:

To aid reviewing, this link shows the diff between @cloudflare/workers-types@4.20240701.0 and the output of the type generation scripts run from this branch.

@penalosa penalosa marked this pull request as ready for review July 11, 2024 20:30
@penalosa penalosa requested review from a team as code owners July 11, 2024 20:30
Copy link
Contributor

@andyjessop andyjessop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! One tiny comment, but the overall approach and implementation looks absolutely fine 👍

types/src/transforms/internal-namespace.ts Outdated Show resolved Hide resolved
@penalosa penalosa merged commit ee484cd into main Jul 12, 2024
9 checks passed
ns476 pushed a commit to ns476/workerd that referenced this pull request Aug 2, 2024
* Create a fully in-memory compiler host, rather than patching the default `ts` compiler host.

This ensures that no filesystem operations are attempted by typescript.

* [new] support additional lib files when constructing an in-memory TS program

* Refactor modifier checking (ensuring `export` and `declare` are in the right place), and ensure no `declare`s inside `module` declarations

* Use new in-memory types for overrides and defines

* Refactor global extraction

* More refactoring

* Fix tests and add updates

* Address comments

* Remove unused code
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants