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

Specify type definitions as dependencies #5766

Merged
merged 1 commit into from
Oct 25, 2023
Merged

Specify type definitions as dependencies #5766

merged 1 commit into from
Oct 25, 2023

Conversation

willeastcott
Copy link
Contributor

We ship type definitions for the engine that contain references to WebXR types. This means that TS projects now have to specify @types/webxr as a dependency:

https://github.com/playcanvas/playcanvas-editor-ts-template/pull/12/files#diff-7ae45ad102eab3b6d7e7896acd08c427a9b25b346470d7bc6507b6481575d519R34

This would be unnecessary if we just made types dependencies instead of devDependencies.

I believe the WebGPU types don't need to be dependencies but, for consistency, I'm moving those to dependencies too. It will avoid any potential future issues around WebGPU type dependencies.

I confirm I have read the contributing guidelines and signed the Contributor License Agreement.

@willeastcott willeastcott requested a review from a team October 24, 2023 11:28
@willeastcott willeastcott self-assigned this Oct 24, 2023
@willeastcott willeastcott merged commit 3e6da60 into main Oct 25, 2023
7 checks passed
@willeastcott willeastcott deleted the types-deps branch October 25, 2023 10:05
@mvaligursky
Copy link
Contributor

This is great, it probably means I no longer need to make module functions private if they use webgpu types in JSDocs.

@willeastcott
Copy link
Contributor Author

I believe that's correct, yes.

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

Successfully merging this pull request may close these issues.

3 participants