-
-
Notifications
You must be signed in to change notification settings - Fork 57
Add --default-platform option to package js
#457
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
Conversation
1. Fixed missing type export (platforms/node.d.ts) - Exported DefaultNodeSetupOptions type that is referenced in index.js 2. Updated index.d.ts to support both platforms - Made init() function accept DefaultNodeSetupOptions for node platform - Made init() function accept Options for browser platform 3. Fixed conditional compilation in node.js - Wrapped getImports() in HAS_IMPORTS conditional (platforms/node.js)
test both browser and node platform variants
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.
Could this become an enum Platform: CaseIterable, so then you would rely on .allCases to dynamically compute help string for all available platforms in the help output you've added below for this new option?
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.
Sounds good! Will do
Please run ./Utilities/format.py for the formatting check to pass.
--platform option to package js (追記ここまで)
--platform option to package js (削除ここまで)--platform option to package js (追記ここまで)
Thanks for the updates! Cleaned up the title:
- "Draft" in the title is not needed, as "Draft" status of PRs already makes that clear.
- We use infinitive form of verbs in PR and commit titles, as with character limit in this field non-infinitive forms don't bring any useful information.
--platformis not a flag, as flags denote binary state and don't take any parameters. E.g.--enable-platform/--disable-platformwithout any parameters would be a flag, but--platform node/--platform browseris an option. If we were able to use Swift Argument Parser in plugins, this would use the@Optionproperty wrapper.
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.
Thank you for putting your effort here! Overall it makes sense to me!
Let me leave a few feedbacks before mering:
- I'd like to keep the generated JS package to be runtime independent as much as possible, so it might be better to name the option as
--default-platform, indicating that only the default entrypointindex.jsis platform dependent, and rest of the modules are still platform independent. The clarification would be partuculary helpful for library author publishing a platform-agnostic JS package containing the JSKit genrated code. - I'm not a big fan of adding
@types/nodedependency here because we use only small surface of Node.js API, and most of the usage is not visible from users (except forWorkertype). I think we can loosen type checks in the Node.js for the sake of the simplicity.
If that sounds reasonable, I can make changes on the top of your branch and merge this PR :)
Cool, yeah that seems reasonable, feel free to to change the patch accordingly! Thank you.
ab3c404 to
617110e
Compare
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.
Thanks!
84243a4
into
swiftwasm:main
--platform option to package js (削除ここまで)--default-platform option to package js (追記ここまで)
Currently
swift package jsonly generates code for the "browser" platform.This PR adds a
--platform node|browser [default: browser]argument that lets you control this behaviour. In case ofnodeit will generate ainitfunction that callsdefaultNodeSetupinstead ofdefaultBrowserSetup.