Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ SWIFT_SDK_ID ?= wasm32-unknown-wasi
.PHONY: bootstrap
bootstrap:
npm ci
cd Plugins/PackageToJS/Templates && npm ci

.PHONY: unittest
unittest:
Expand Down
8 changes: 8 additions & 0 deletions Plugins/PackageToJS/Sources/PackageToJS.swift
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,19 @@ import Foundation

struct PackageToJS {
struct PackageOptions {
enum Platform: String, CaseIterable {
case browser
case node
}

/// Path to the output directory
var outputPath: String?
/// The build configuration to use (default: debug)
var configuration: String?
/// Name of the package (default: lowercased Package.swift name)
var packageName: String?
/// Target platform for the generated JavaScript (default: browser)
var platform: Platform = .browser
/// Whether to explain the build plan (default: false)
var explain: Bool = false
/// Whether to print verbose output
Expand Down Expand Up @@ -717,6 +724,7 @@ 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,
]
let constantSubstitutions: [String: String] = [
"PACKAGE_TO_JS_MODULE_PATH": wasmFilename,
Expand Down
32 changes: 25 additions & 7 deletions Plugins/PackageToJS/Sources/PackageToJSPlugin.swift
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ struct PackageToJSPlugin: CommandPlugin {
}

var extractor = ArgumentExtractor(arguments)
let buildOptions = PackageToJS.BuildOptions.parse(from: &extractor)
let buildOptions = try PackageToJS.BuildOptions.parse(from: &extractor)

if extractor.remainingArguments.count > 0 {
printStderr(
Expand Down Expand Up @@ -239,7 +239,7 @@ struct PackageToJSPlugin: CommandPlugin {
}

var extractor = ArgumentExtractor(arguments)
let testOptions = PackageToJS.TestOptions.parse(from: &extractor)
let testOptions = try PackageToJS.TestOptions.parse(from: &extractor)

if extractor.remainingArguments.count > 0 {
printStderr(
Expand Down Expand Up @@ -440,12 +440,28 @@ private func printStderr(_ message: String) {

// MARK: - Options parsing

extension ArgumentExtractor {
mutating func extractPlatformOption(named name: String) throws -> PackageToJS.PackageOptions.Platform {
guard let stringValue = self.extractOption(named: name).last else {
return .browser
}

guard let platform = PackageToJS.PackageOptions.Platform(rawValue: stringValue) else {
throw PackageToJSError(
"Invalid platform: \(stringValue), expected one of \(PackageToJS.PackageOptions.Platform.allCases.map(\.rawValue).joined(separator: ", "))"
)
}
return platform
}
}

extension PackageToJS.PackageOptions {
static func parse(from extractor: inout ArgumentExtractor) -> PackageToJS.PackageOptions {
static func parse(from extractor: inout ArgumentExtractor) throws -> PackageToJS.PackageOptions {
let outputPath = extractor.extractOption(named: "output").last
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 explain = extractor.extractFlag(named: "explain")
let useCDN = extractor.extractFlag(named: "use-cdn")
let verbose = extractor.extractFlag(named: "verbose")
Expand All @@ -454,6 +470,7 @@ extension PackageToJS.PackageOptions {
outputPath: outputPath,
configuration: configuration,
packageName: packageName,
platform: platform,
explain: explain != 0,
verbose: verbose != 0,
useCDN: useCDN != 0,
Expand All @@ -466,6 +483,7 @@ extension PackageToJS.PackageOptions {
--output <path> Path to the output directory (default: .build/plugins/PackageToJS/outputs/Package)
-c, --configuration <name> The build configuration to use (values: debug, release; default: debug)
--package-name <name> Name of the package (default: lowercased Package.swift name)
--platform <name> Target platform for generated JavaScript (values: \(PackageToJS.PackageOptions.Platform.allCases.map(\.rawValue).joined(separator: ", ")); default: \(PackageToJS.PackageOptions.Platform.browser))
--use-cdn Whether to use CDN for dependency packages
--enable-code-coverage Whether to enable code coverage collection
--explain Whether to explain the build plan
Expand All @@ -475,7 +493,7 @@ extension PackageToJS.PackageOptions {
}

extension PackageToJS.BuildOptions {
static func parse(from extractor: inout ArgumentExtractor) -> PackageToJS.BuildOptions {
static func parse(from extractor: inout ArgumentExtractor) throws -> PackageToJS.BuildOptions {
let product = extractor.extractOption(named: "product").last
let noOptimize = extractor.extractFlag(named: "no-optimize")
let rawDebugInfoFormat = extractor.extractOption(named: "debug-info-format").last
Expand All @@ -488,7 +506,7 @@ extension PackageToJS.BuildOptions {
}
debugInfoFormat = format
}
let packageOptions = PackageToJS.PackageOptions.parse(from: &extractor)
let packageOptions = try PackageToJS.PackageOptions.parse(from: &extractor)
return PackageToJS.BuildOptions(
product: product,
noOptimize: noOptimize != 0,
Expand Down Expand Up @@ -526,15 +544,15 @@ extension PackageToJS.BuildOptions {
}

extension PackageToJS.TestOptions {
static func parse(from extractor: inout ArgumentExtractor) -> PackageToJS.TestOptions {
static func parse(from extractor: inout ArgumentExtractor) throws -> PackageToJS.TestOptions {
let buildOnly = extractor.extractFlag(named: "build-only")
let listTests = extractor.extractFlag(named: "list-tests")
let filter = extractor.extractOption(named: "filter")
let prelude = extractor.extractOption(named: "prelude").last
let environment = extractor.extractOption(named: "environment").last
let inspect = extractor.extractFlag(named: "inspect")
let extraNodeArguments = extractor.extractSingleDashOption(named: "Xnode")
let packageOptions = PackageToJS.PackageOptions.parse(from: &extractor)
let packageOptions = try PackageToJS.PackageOptions.parse(from: &extractor)
var options = PackageToJS.TestOptions(
buildOnly: buildOnly != 0,
listTests: listTests != 0,
Expand Down
14 changes: 14 additions & 0 deletions Plugins/PackageToJS/Templates/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
import type { Exports, Imports, ModuleSource } from './instantiate.js'
/* #if TARGET_PLATFORM_NODE */
import type { DefaultNodeSetupOptions } from './platforms/node.js'
/* #endif */

export type Options = {
/**
Expand All @@ -18,10 +21,21 @@ 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 */
16 changes: 16 additions & 0 deletions Plugins/PackageToJS/Templates/index.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,24 @@
// @ts-check
import { instantiate } from './instantiate.js';
/* #if TARGET_PLATFORM_NODE */
import { defaultNodeSetup /* #if USE_SHARED_MEMORY */, createDefaultWorkerFactory /* #endif */} from './platforms/node.js';
/* #else */
import { defaultBrowserSetup /* #if USE_SHARED_MEMORY */, createDefaultWorkerFactory /* #endif */} from './platforms/browser.js';
/* #endif */

/** @type {import('./index.d').init} */
export async function init(_options) {
/* #if TARGET_PLATFORM_NODE */
/** @type {import('./platforms/node.d.ts').DefaultNodeSetupOptions} */
const options = _options || {};
const instantiateOptions = await defaultNodeSetup({
args: options.args,
onExit: options.onExit,
/* #if USE_SHARED_MEMORY */
spawnWorker: options.spawnWorker || createDefaultWorkerFactory()
/* #endif */
});
/* #else */
/** @type {import('./index.d').Options} */
const options = _options || {
/* #if HAS_IMPORTS */
Expand All @@ -24,5 +39,6 @@ export async function init(_options) {
spawnWorker: createDefaultWorkerFactory()
/* #endif */
})
/* #endif */
return await instantiate(instantiateOptions);
}
41 changes: 41 additions & 0 deletions Plugins/PackageToJS/Templates/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions Plugins/PackageToJS/Templates/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,8 @@
},
"dependencies": {
"@bjorn3/browser_wasi_shim": "0.3.0"
},
"devDependencies": {
"@types/node": "^22.0.0"
}
}
6 changes: 4 additions & 2 deletions Plugins/PackageToJS/Templates/platforms/node.d.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
import type { InstantiateOptions } from "../instantiate.js"
import type { Worker } from "node:worker_threads"

export function defaultNodeSetup(options: {
export type DefaultNodeSetupOptions = {
/* #if IS_WASI */
args?: string[],
/* #endif */
onExit?: (code: number) => void,
/* #if USE_SHARED_MEMORY */
spawnWorker: (module: WebAssembly.Module, memory: WebAssembly.Memory, startArg: any) => Worker,
/* #endif */
}): Promise<InstantiateOptions>
}

export function defaultNodeSetup(options: DefaultNodeSetupOptions): Promise<InstantiateOptions>

export function createDefaultWorkerFactory(preludeScript: string): (module: WebAssembly.Module, memory: WebAssembly.Memory, startArg: any) => Worker
2 changes: 2 additions & 0 deletions Plugins/PackageToJS/Templates/platforms/node.js
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,9 @@ export async function defaultNodeSetup(options) {

return {
module,
/* #if HAS_IMPORTS */
getImports() { return {} },
/* #endif */
/* #if IS_WASI */
wasi: Object.assign(wasi, {
setInstance(instance) {
Expand Down
42 changes: 40 additions & 2 deletions Plugins/PackageToJS/Tests/TemplatesTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,48 @@ import Foundation
.appendingPathComponent("Templates")

/// `npx tsc -p Templates/tsconfig.json`
@Test func tscCheck() throws {
/// Test both node and browser platform variants
@Test(arguments: ["node", "browser"])
func tscCheck(platform: String) throws {
// Create a temporary directory for preprocessed files
let tempDir = FileManager.default.temporaryDirectory
.appendingPathComponent("JavaScriptKit-tsc-\(platform)-\(UUID().uuidString)")
defer {
try? FileManager.default.removeItem(at: tempDir)
}

// Copy entire templates folder to temp location
try FileManager.default.copyItem(at: Self.templatesPath, to: tempDir)

// Setup preprocessing conditions
let conditions: [String: Bool] = [
"USE_SHARED_MEMORY": false,
"IS_WASI": true,
"USE_WASI_CDN": false,
"HAS_BRIDGE": false,
"HAS_IMPORTS": platform == "browser",
"TARGET_PLATFORM_NODE": platform == "node",
]
let preprocessOptions = PreprocessOptions(conditions: conditions, substitutions: [:])

// Preprocess all JS and TS files in-place
let enumerator = FileManager.default.enumerator(at: tempDir, includingPropertiesForKeys: nil)
while let fileURL = enumerator?.nextObject() as? URL {
guard !fileURL.hasDirectoryPath,
fileURL.pathExtension == "js" || fileURL.pathExtension == "ts"
else {
continue
}

let content = try String(contentsOf: fileURL, encoding: .utf8)
let preprocessed = try preprocess(source: content, file: fileURL.path, options: preprocessOptions)
try preprocessed.write(to: fileURL, atomically: true, encoding: .utf8)
}

// Run TypeScript on the preprocessed files
let tsc = Process()
tsc.executableURL = try which("npx")
tsc.arguments = ["tsc", "-p", Self.templatesPath.appending(path: "tsconfig.json").path]
tsc.arguments = ["tsc", "-p", tempDir.appending(path: "tsconfig.json").path]
try tsc.run()
tsc.waitUntilExit()
#expect(tsc.terminationStatus == 0)
Expand Down
Loading