-
Notifications
You must be signed in to change notification settings - Fork 74
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
Add support for Deno with an index-deno.ts #2522
Merged
Merged
Conversation
This file contains 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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Automatically approving tomaka's pull requests. This auto-approval will be removed once more maintainers are active.
twiggy diff reportDifference in .wasm size before and after this pull request.
|
melekes
approved these changes
Jul 19, 2022
harrysolovay
approved these changes
Jul 19, 2022
Should be merged together with #2533 |
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.
Adds a new
index-deno.ts
file, similar toindex-nodejs.ts
andindex-browser.ts
.This file gets compiled by TypeScript, which generates
dist/mjs/index-deno.js
.The content of
dist/mjs
can then be published to the deno.land/x registry.The reason for not publishing directly the content of
src
on the Deno registry is that Deno requires paths to modules to always end with a.ts
extension, while regular TypeScript requires paths to end with either no extension or with.js
.It is therefore impossible to write code that works on both non-Deno TypeScript and Deno TypeScript (unless that code is squashed together within a single module, which I've considered, but this isn't worth the trade-off).
Because the Deno types aren't available on NPM (well, they actually are, but not maintained), I had to copy-paste the types found in the Deno repository.
Considering that we are only using stable APIs, I expect these types to never need to be updated. Fingers crossed that I will not be proven wrong.
We now run
deno run ./dist/mjs/index-deno.js
in the CI, which should ensure that compatibility never breaks.I've also added a
demo/demo-deno.ts
file, which isn't tested by CI but can be run from Deno in order to make sure that everything is working.