PackageToJS: Rename --platform to --default-platform and fix tests

Author: kateinoigakukun

Makefile

@@ -3,7 +3,6 @@ SWIFT_SDK_ID ?= wasm32-unknown-wasi
 .PHONY: bootstrap
 bootstrap:
 	npm ci
-	cd Plugins/PackageToJS/Templates && npm ci
 
 .PHONY: unittest
 unittest:

Plugins/PackageToJS/Sources/PackageToJS.swift

@@ -14,7 +14,7 @@ struct PackageToJS {
         /// Name of the package (default: lowercased Package.swift name)
         var packageName: String?
         /// Target platform for the generated JavaScript (default: browser)
-        var platform: Platform = .browser
+        var defaultPlatform: Platform = .browser
         /// Whether to explain the build plan (default: false)
         var explain: Bool = false
         /// Whether to print verbose output
@@ -724,7 +724,8 @@ struct PackagingPlanner {
             "USE_WASI_CDN": options.useCDN,
             "HAS_BRIDGE": exportedSkeletons.count > 0 || importedSkeletons.count > 0,
             "HAS_IMPORTS": importedSkeletons.count > 0,
-            "TARGET_PLATFORM_NODE": options.platform == .node,
+            "TARGET_DEFAULT_PLATFORM_NODE": options.defaultPlatform == .node,
+            "TARGET_DEFAULT_PLATFORM_BROWSER": options.defaultPlatform == .browser,
         ]
         let constantSubstitutions: [String: String] = [
             "PACKAGE_TO_JS_MODULE_PATH": wasmFilename,

Plugins/PackageToJS/Sources/PackageToJSPlugin.swift

@@ -461,7 +461,7 @@ extension PackageToJS.PackageOptions {
         let configuration: String? =
             (extractor.extractOption(named: "configuration") + extractor.extractSingleDashOption(named: "c")).last
         let packageName = extractor.extractOption(named: "package-name").last
-        let platform = try extractor.extractPlatformOption(named: "platform")
+        let defaultPlatform = try extractor.extractPlatformOption(named: "default-platform")
         let explain = extractor.extractFlag(named: "explain")
         let useCDN = extractor.extractFlag(named: "use-cdn")
         let verbose = extractor.extractFlag(named: "verbose")
@@ -470,7 +470,7 @@ extension PackageToJS.PackageOptions {
             outputPath: outputPath,
             configuration: configuration,
             packageName: packageName,
-            platform: platform,
+            defaultPlatform: defaultPlatform,
             explain: explain != 0,
             verbose: verbose != 0,
             useCDN: useCDN != 0,

Plugins/PackageToJS/Templates/index.d.ts

@@ -1,15 +1,14 @@
 import type { Exports, Imports, ModuleSource } from './instantiate.js'
-/* #if TARGET_PLATFORM_NODE */
-import type { DefaultNodeSetupOptions } from './platforms/node.js'
-/* #endif */
 
 export type Options = {
+/* #if TARGET_DEFAULT_PLATFORM_BROWSER */
     /**
      * The WebAssembly module to instantiate
      *
      * If not provided, the module will be fetched from the default path.
      */
     module?: ModuleSource
+/* #endif */
 /* #if HAS_IMPORTS */
     /**
      * The imports to use for the module
@@ -21,21 +20,10 @@ export type Options = {
 /**
  * Instantiate and initialize the module
  *
-/* #if TARGET_PLATFORM_NODE */
- * This is a convenience function for Node.js environments.
-/* #else */
  * This is a convenience function for browser environments.
-/* #endif */
  * If you need a more flexible API, see `instantiate`.
  */
-/* #if TARGET_PLATFORM_NODE */
-export declare function init(options?: DefaultNodeSetupOptions): Promise<{
-    instance: WebAssembly.Instance,
-    exports: Exports
-}>
-/* #else */
 export declare function init(options?: Options): Promise<{
     instance: WebAssembly.Instance,
     exports: Exports
 }>
-/* #endif */

Plugins/PackageToJS/Templates/index.js

@@ -1,24 +1,29 @@
 // @ts-check
 import { instantiate } from './instantiate.js';
-/* #if TARGET_PLATFORM_NODE */
-import { defaultNodeSetup /* #if USE_SHARED_MEMORY */, createDefaultWorkerFactory /* #endif */} from './platforms/node.js';
+/* #if TARGET_DEFAULT_PLATFORM_NODE */
+import { defaultNodeSetup /* #if USE_SHARED_MEMORY */, createDefaultWorkerFactory as createDefaultWorkerFactoryForNode /* #endif */} from './platforms/node.js';
 /* #else */
-import { defaultBrowserSetup /* #if USE_SHARED_MEMORY */, createDefaultWorkerFactory /* #endif */} from './platforms/browser.js';
+import { defaultBrowserSetup /* #if USE_SHARED_MEMORY */, createDefaultWorkerFactory as createDefaultWorkerFactoryForBrowser /* #endif */} from './platforms/browser.js';
 /* #endif */
 
+/* #if TARGET_DEFAULT_PLATFORM_NODE */
 /** @type {import('./index.d').init} */
-export async function init(_options) {
-/* #if TARGET_PLATFORM_NODE */
+async function initNode(_options) {
     /** @type {import('./platforms/node.d.ts').DefaultNodeSetupOptions} */
-    const options = _options || {};
-    const instantiateOptions = await defaultNodeSetup({
-        args: options.args,
-        onExit: options.onExit,
+    const options = {
+        ...(_options || {}),
 /* #if USE_SHARED_MEMORY */
-        spawnWorker: options.spawnWorker || createDefaultWorkerFactory()
+        spawnWorker: createDefaultWorkerFactoryForNode(),
 /* #endif */
-    });
+    };
+    const instantiateOptions = await defaultNodeSetup(options);
+    return await instantiate(instantiateOptions);
+}
+
 /* #else */
+
+/** @type {import('./index.d').init} */
+async function initBrowser(_options) {
     /** @type {import('./index.d').Options} */
     const options = _options || {
 /* #if HAS_IMPORTS */
@@ -36,9 +41,19 @@ export async function init(_options) {
         getImports: () => options.getImports(),
 /* #endif */
 /* #if USE_SHARED_MEMORY */
-        spawnWorker: createDefaultWorkerFactory()
+        spawnWorker: createDefaultWorkerFactoryForBrowser()
 /* #endif */
     })
-/* #endif */
     return await instantiate(instantiateOptions);
 }
+
+/* #endif */
+
+/** @type {import('./index.d').init} */
+export async function init(options) {
+    /* #if TARGET_DEFAULT_PLATFORM_NODE */
+    return initNode(options);
+    /* #else */
+    return initBrowser(options);
+    /* #endif */
+}

Plugins/PackageToJS/Templates/package-lock.json

@@ -9,8 +9,5 @@
     },
     "dependencies": {
         "@bjorn3/browser_wasi_shim": "0.3.0"
-    },
-    "devDependencies": {
-        "@types/node": "^22.0.0"
     }
 }

Plugins/PackageToJS/Templates/package.json

@@ -13,4 +13,4 @@ export type DefaultNodeSetupOptions = {
 
 export function defaultNodeSetup(options: DefaultNodeSetupOptions): Promise<InstantiateOptions>
 
-export function createDefaultWorkerFactory(preludeScript: string): (module: WebAssembly.Module, memory: WebAssembly.Memory, startArg: any) => Worker
+export function createDefaultWorkerFactory(preludeScript?: string): (module: WebAssembly.Module, memory: WebAssembly.Memory, startArg: any) => Worker

Plugins/PackageToJS/Templates/platforms/node.d.ts

@@ -131,7 +131,7 @@ export async function defaultNodeSetup(options) {
         new PreopenDirectory("/", rootFs),
     ], { debug: false })
     const pkgDir = path.dirname(path.dirname(fileURLToPath(import.meta.url)))
-    const module = await WebAssembly.compile(await readFile(path.join(pkgDir, MODULE_PATH)))
+    const module = await WebAssembly.compile(new Uint8Array(await readFile(path.join(pkgDir, MODULE_PATH))))
 /* #if USE_SHARED_MEMORY */
     const memory = new WebAssembly.Memory(MEMORY_TYPE);
     const threadChannel = new DefaultNodeThreadRegistry(options.spawnWorker)

Plugins/PackageToJS/Templates/platforms/node.js

@@ -1,6 +1,7 @@
 {
     "compilerOptions": {
         "module": "esnext",
+        "lib": ["es2017", "dom"],
         "noEmit": true,
         "allowJs": true,
         "skipLibCheck": true,