feat(engine): types for modules #381
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
FelipeTrost
force-pushed
the
engine/types
branch
from
895d1d4 to
2ff9286
Compare
This comment has been minimized.
This comment has been minimized.
Contributor
|
As discussed on Monday, I think it would be good if we could automate this with a post-install and post-merge hook combo. |
when webpack bundles the engine it inevitably produces ts->js outputs, i'm saving those to types, so that they get ignored during the pipeline
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
✅ Successfully created Preview Deployment. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Added a build step that adds types for the modules in the engine with
yarn build-engine-types.The modules in the monorepo are treated as npm packages, and the typescript language server doesn't perform inference on them, so this build step allows typescript to infer types for the modules the best it can.
In the future, we could also entirely build the packages that use typescript if it's needed with not much effort.
Note
You have to run
yarn buildbefore runningyarn build-engine-typesthis dependency can be fixed, and I plan to do it in the future.Details
Every module has a
tsconfig.jsonthat specifies where the types should go, all thetsconfig.jsoninside thesrc/enginefolder extend thetsconfig.jsonin the root folder of the repo.In order to cache builds I used turbo, which also can generate a dependency graph with
yarn turbo run build --graph=graph.pdf