diff --git a/Benchmarks/Package.swift b/Benchmarks/Package.swift index 4d59c772..8e11282e 100644 --- a/Benchmarks/Package.swift +++ b/Benchmarks/Package.swift @@ -11,7 +11,7 @@ let package = Package( .executableTarget( name: "Benchmarks", dependencies: ["JavaScriptKit"], - exclude: ["Generated/JavaScript", "bridge.d.ts"], + exclude: ["Generated/JavaScript", "bridge-js.d.ts"], swiftSettings: [ .enableExperimentalFeature("Extern") ] diff --git a/Benchmarks/Sources/bridge-js.config.json b/Benchmarks/Sources/bridge-js.config.json new file mode 100644 index 00000000..9e26dfee --- /dev/null +++ b/Benchmarks/Sources/bridge-js.config.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/Benchmarks/Sources/bridge.d.ts b/Benchmarks/Sources/bridge-js.d.ts similarity index 100% rename from Benchmarks/Sources/bridge.d.ts rename to Benchmarks/Sources/bridge-js.d.ts diff --git a/Examples/ImportTS/Sources/bridge.d.ts b/Examples/ImportTS/Sources/bridge-js.d.ts similarity index 100% rename from Examples/ImportTS/Sources/bridge.d.ts rename to Examples/ImportTS/Sources/bridge-js.d.ts diff --git a/Examples/ImportTS/Sources/main.swift b/Examples/ImportTS/Sources/main.swift index 4328b0a3..4853a966 100644 --- a/Examples/ImportTS/Sources/main.swift +++ b/Examples/ImportTS/Sources/main.swift @@ -1,9 +1,9 @@ import JavaScriptKit // This function is automatically generated by the @JS plugin -// It demonstrates how to use TypeScript functions and types imported from bridge.d.ts +// It demonstrates how to use TypeScript functions and types imported from bridge-js.d.ts @JS public func run() { - // Call the imported consoleLog function defined in bridge.d.ts + // Call the imported consoleLog function defined in bridge-js.d.ts consoleLog("Hello, World!") // Get the document object - this comes from the imported getDocument() function diff --git a/Plugins/BridgeJS/README.md b/Plugins/BridgeJS/README.md index 9cbd0401..2fb6458a 100644 --- a/Plugins/BridgeJS/README.md +++ b/Plugins/BridgeJS/README.md @@ -22,7 +22,7 @@ graph LR A.swift --> E1[[bridge-js export]] B.swift --> E1 E1 --> G1[ExportSwift.swift] - B1[bridge.d.ts]-->I1[[bridge-js import]] + B1[bridge-js.d.ts]-->I1[[bridge-js import]] I1 --> G2[ImportTS.swift] end I1 --> G4[ImportTS.json] @@ -32,7 +32,7 @@ graph LR C.swift --> E2[[bridge-js export]] D.swift --> E2 E2 --> G5[ExportSwift.swift] - B2[bridge.d.ts]-->I2[[bridge-js import]] + B2[bridge-js.d.ts]-->I2[[bridge-js import]] I2 --> G6[ImportTS.swift] end I2 --> G8[ImportTS.json] @@ -42,8 +42,8 @@ graph LR G7 --> L1 G8 --> L1 - L1 --> F1[bridge.js] - L1 --> F2[bridge.d.ts] + L1 --> F1[bridge-js.js] + L1 --> F2[bridge-js.d.ts] ModuleA -----> App[App.wasm] ModuleB -----> App diff --git a/Plugins/BridgeJS/Sources/BridgeJSBuildPlugin/BridgeJSBuildPlugin.swift b/Plugins/BridgeJS/Sources/BridgeJSBuildPlugin/BridgeJSBuildPlugin.swift index 4ea725ed..c9ea8987 100644 --- a/Plugins/BridgeJS/Sources/BridgeJSBuildPlugin/BridgeJSBuildPlugin.swift +++ b/Plugins/BridgeJS/Sources/BridgeJSBuildPlugin/BridgeJSBuildPlugin.swift @@ -11,17 +11,32 @@ struct BridgeJSBuildPlugin: BuildToolPlugin { guard let swiftSourceModuleTarget = target as? SwiftSourceModuleTarget else { return [] } - return try [ - createExportSwiftCommand(context: context, target: swiftSourceModuleTarget), - createImportTSCommand(context: context, target: swiftSourceModuleTarget), - ] + var commands: [Command] = [] + commands.append(try createExportSwiftCommand(context: context, target: swiftSourceModuleTarget)) + if let importCommand = try createImportTSCommand(context: context, target: swiftSourceModuleTarget) { + commands.append(importCommand) + } + return commands + } + + private func pathToConfigFile(target: SwiftSourceModuleTarget) -> URL { + return target.directoryURL.appending(path: "bridge-js.config.json") } private func createExportSwiftCommand(context: PluginContext, target: SwiftSourceModuleTarget) throws -> Command { let outputSwiftPath = context.pluginWorkDirectoryURL.appending(path: "ExportSwift.swift") let outputSkeletonPath = context.pluginWorkDirectoryURL.appending(path: "ExportSwift.json") - let inputFiles = target.sourceFiles.filter { !$0.url.path.hasPrefix(context.pluginWorkDirectoryURL.path + "/") } - .map(\.url) + let inputSwiftFiles = target.sourceFiles.filter { + !$0.url.path.hasPrefix(context.pluginWorkDirectoryURL.path + "/") + } + .map(\.url) + let configFile = pathToConfigFile(target: target) + let inputFiles: [URL] + if FileManager.default.fileExists(atPath: configFile.path) { + inputFiles = inputSwiftFiles + [configFile] + } else { + inputFiles = inputSwiftFiles + } return .buildCommand( displayName: "Export Swift API", executable: try context.tool(named: "BridgeJSTool").url, @@ -31,8 +46,10 @@ struct BridgeJSBuildPlugin: BuildToolPlugin { outputSkeletonPath.path, "--output-swift", outputSwiftPath.path, + // Generate the output files even if nothing is exported not to surprise + // the build system. "--always-write", "true", - ] + inputFiles.map(\.path), + ] + inputSwiftFiles.map(\.path), inputFiles: inputFiles, outputFiles: [ outputSwiftPath @@ -40,12 +57,21 @@ struct BridgeJSBuildPlugin: BuildToolPlugin { ) } - private func createImportTSCommand(context: PluginContext, target: SwiftSourceModuleTarget) throws -> Command { + private func createImportTSCommand(context: PluginContext, target: SwiftSourceModuleTarget) throws -> Command? { let outputSwiftPath = context.pluginWorkDirectoryURL.appending(path: "ImportTS.swift") let outputSkeletonPath = context.pluginWorkDirectoryURL.appending(path: "ImportTS.json") - let inputFiles = [ - target.directoryURL.appending(path: "bridge.d.ts") - ] + let inputTSFile = target.directoryURL.appending(path: "bridge-js.d.ts") + guard FileManager.default.fileExists(atPath: inputTSFile.path) else { + return nil + } + + let configFile = pathToConfigFile(target: target) + let inputFiles: [URL] + if FileManager.default.fileExists(atPath: configFile.path) { + inputFiles = [inputTSFile, configFile] + } else { + inputFiles = [inputTSFile] + } return .buildCommand( displayName: "Import TypeScript API", executable: try context.tool(named: "BridgeJSTool").url, @@ -57,10 +83,13 @@ struct BridgeJSBuildPlugin: BuildToolPlugin { outputSwiftPath.path, "--module-name", target.name, + // Generate the output files even if nothing is imported not to surprise + // the build system. "--always-write", "true", "--project", context.package.directoryURL.appending(path: "tsconfig.json").path, - ] + inputFiles.map(\.path), + inputTSFile.path, + ], inputFiles: inputFiles, outputFiles: [ outputSwiftPath diff --git a/Plugins/BridgeJS/Sources/BridgeJSCommandPlugin/BridgeJSCommandPlugin.swift b/Plugins/BridgeJS/Sources/BridgeJSCommandPlugin/BridgeJSCommandPlugin.swift index 286b052d..f20f7837 100644 --- a/Plugins/BridgeJS/Sources/BridgeJSCommandPlugin/BridgeJSCommandPlugin.swift +++ b/Plugins/BridgeJS/Sources/BridgeJSCommandPlugin/BridgeJSCommandPlugin.swift @@ -12,10 +12,12 @@ struct BridgeJSCommandPlugin: CommandPlugin { struct Options { var targets: [String] + var verbose: Bool static func parse(extractor: inout ArgumentExtractor) -> Options { let targets = extractor.extractOption(named: "target") - return Options(targets: targets) + let verbose = extractor.extractFlag(named: "verbose") + return Options(targets: targets, verbose: verbose != 0) } static func help() -> String { @@ -29,13 +31,13 @@ struct BridgeJSCommandPlugin: CommandPlugin { OPTIONS: --target Specify target(s) to generate bridge code for. If omitted, generates for all targets with JavaScriptKit dependency. + --verbose Print verbose output. """ } } func performCommand(context: PluginContext, arguments: [String]) throws { // Check for help flags to display usage information - // This allows users to run `swift package plugin bridge-js --help` to understand the plugin's functionality if arguments.contains(where: { ["-h", "--help"].contains($0) }) { printStderr(Options.help()) return @@ -45,25 +47,31 @@ struct BridgeJSCommandPlugin: CommandPlugin { let options = Options.parse(extractor: &extractor) let remainingArguments = extractor.remainingArguments + let context = Context(options: options, context: context) + if options.targets.isEmpty { - try runOnTargets( - context: context, + try context.runOnTargets( remainingArguments: remainingArguments, where: { target in target.hasDependency(named: Self.JAVASCRIPTKIT_PACKAGE_NAME) } ) } else { - try runOnTargets( - context: context, + try context.runOnTargets( remainingArguments: remainingArguments, where: { options.targets.contains($0.name) } ) } } - private func runOnTargets( - context: PluginContext, + struct Context { + let options: Options + let context: PluginContext + } +} + +extension BridgeJSCommandPlugin.Context { + func runOnTargets( remainingArguments: [String], where predicate: (SwiftSourceModuleTarget) -> Bool ) throws { @@ -71,57 +79,71 @@ struct BridgeJSCommandPlugin: CommandPlugin { guard let target = target as? SwiftSourceModuleTarget else { continue } + let configFilePath = target.directoryURL.appending(path: "bridge-js.config.json") + if !FileManager.default.fileExists(atPath: configFilePath.path) { + printVerbose("No bridge-js.config.json found for \(target.name), skipping...") + continue + } guard predicate(target) else { continue } - try runSingleTarget(context: context, target: target, remainingArguments: remainingArguments) + try runSingleTarget(target: target, remainingArguments: remainingArguments) } } private func runSingleTarget( - context: PluginContext, target: SwiftSourceModuleTarget, remainingArguments: [String] ) throws { - Diagnostics.progress("Exporting Swift API for \(target.name)...") + printStderr("Generating bridge code for \(target.name)...") + + printVerbose("Exporting Swift API for \(target.name)...") let generatedDirectory = target.directoryURL.appending(path: "Generated") let generatedJavaScriptDirectory = generatedDirectory.appending(path: "JavaScript") try runBridgeJSTool( - context: context, arguments: [ "export", "--output-skeleton", generatedJavaScriptDirectory.appending(path: "ExportSwift.json").path, "--output-swift", generatedDirectory.appending(path: "ExportSwift.swift").path, + "--verbose", + options.verbose ? "true" : "false", ] + target.sourceFiles.filter { !$0.url.path.hasPrefix(generatedDirectory.path + "/") }.map(\.url.path) + remainingArguments ) - try runBridgeJSTool( - context: context, - arguments: [ - "import", - "--output-skeleton", - generatedJavaScriptDirectory.appending(path: "ImportTS.json").path, - "--output-swift", - generatedDirectory.appending(path: "ImportTS.swift").path, - "--module-name", - target.name, - "--project", - context.package.directoryURL.appending(path: "tsconfig.json").path, - target.directoryURL.appending(path: "bridge.d.ts").path, - ] + remainingArguments - ) + printVerbose("Importing TypeScript API for \(target.name)...") + + let bridgeDtsPath = target.directoryURL.appending(path: "bridge-js.d.ts") + // Execute import only if bridge-js.d.ts exists + if FileManager.default.fileExists(atPath: bridgeDtsPath.path) { + try runBridgeJSTool( + arguments: [ + "import", + "--output-skeleton", + generatedJavaScriptDirectory.appending(path: "ImportTS.json").path, + "--output-swift", + generatedDirectory.appending(path: "ImportTS.swift").path, + "--verbose", + options.verbose ? "true" : "false", + "--module-name", + target.name, + "--project", + context.package.directoryURL.appending(path: "tsconfig.json").path, + bridgeDtsPath.path, + ] + remainingArguments + ) + } } - private func runBridgeJSTool(context: PluginContext, arguments: [String]) throws { + private func runBridgeJSTool(arguments: [String]) throws { let tool = try context.tool(named: "BridgeJSTool").url - printStderr("$ \(tool.path) \(arguments.joined(separator: " "))") + printVerbose("$ \(tool.path) \(arguments.joined(separator: " "))") let process = Process() process.executableURL = tool process.arguments = arguments @@ -133,6 +155,12 @@ struct BridgeJSCommandPlugin: CommandPlugin { exit(process.terminationStatus) } } + + private func printVerbose(_ message: String) { + if options.verbose { + printStderr(message) + } + } } private func printStderr(_ message: String) { diff --git a/Plugins/BridgeJS/Sources/BridgeJSTool/BridgeJSTool.swift b/Plugins/BridgeJS/Sources/BridgeJSTool/BridgeJSTool.swift index a6bd5ff5..396adcc2 100644 --- a/Plugins/BridgeJS/Sources/BridgeJSTool/BridgeJSTool.swift +++ b/Plugins/BridgeJS/Sources/BridgeJSTool/BridgeJSTool.swift @@ -57,7 +57,6 @@ import SwiftParser """ ) } - let progress = ProgressReporting() switch subcommand { case "import": let parser = ArgumentParser( @@ -71,6 +70,10 @@ import SwiftParser help: "Always write the output files even if no APIs are imported", required: false ), + "verbose": OptionRule( + help: "Print verbose output", + required: false + ), "output-swift": OptionRule(help: "The output file path for the Swift source code", required: true), "output-skeleton": OptionRule( help: "The output file path for the skeleton of the imported TypeScript APIs", @@ -85,6 +88,7 @@ import SwiftParser let (positionalArguments, _, doubleDashOptions) = try parser.parse( arguments: Array(arguments.dropFirst()) ) + let progress = ProgressReporting(verbose: doubleDashOptions["verbose"] == "true") var importer = ImportTS(progress: progress, moduleName: doubleDashOptions["module-name"]!) for inputFile in positionalArguments { if inputFile.hasSuffix(".json") { @@ -145,11 +149,16 @@ import SwiftParser help: "Always write the output files even if no APIs are exported", required: false ), + "verbose": OptionRule( + help: "Print verbose output", + required: false + ), ] ) let (positionalArguments, _, doubleDashOptions) = try parser.parse( arguments: Array(arguments.dropFirst()) ) + let progress = ProgressReporting(verbose: doubleDashOptions["verbose"] == "true") let exporter = ExportSwift(progress: progress) for inputFile in positionalArguments { let sourceURL = URL(fileURLWithPath: inputFile) @@ -253,7 +262,11 @@ private func printStderr(_ message: String) { struct ProgressReporting { let print: (String) -> Void - init(print: @escaping (String) -> Void = { Swift.print($0) }) { + init(verbose: Bool) { + self.init(print: verbose ? { Swift.print($0) } : { _ in }) + } + + private init(print: @escaping (String) -> Void) { self.print = print } diff --git a/Plugins/BridgeJS/Sources/BridgeJSTool/ExportSwift.swift b/Plugins/BridgeJS/Sources/BridgeJSTool/ExportSwift.swift index 9b401347..2e0180fa 100644 --- a/Plugins/BridgeJS/Sources/BridgeJSTool/ExportSwift.swift +++ b/Plugins/BridgeJS/Sources/BridgeJSTool/ExportSwift.swift @@ -19,7 +19,7 @@ class ExportSwift { private var exportedClasses: [ExportedClass] = [] private var typeDeclResolver: TypeDeclResolver = TypeDeclResolver() - init(progress: ProgressReporting = ProgressReporting()) { + init(progress: ProgressReporting) { self.progress = progress } diff --git a/Plugins/BridgeJS/Sources/JavaScript/src/cli.js b/Plugins/BridgeJS/Sources/JavaScript/src/cli.js index 6d2a1ed8..f708082c 100644 --- a/Plugins/BridgeJS/Sources/JavaScript/src/cli.js +++ b/Plugins/BridgeJS/Sources/JavaScript/src/cli.js @@ -6,7 +6,15 @@ import ts from 'typescript'; import path from 'path'; class DiagnosticEngine { - constructor() { + /** + * @param {string} level + */ + constructor(level) { + const levelInfo = DiagnosticEngine.LEVELS[level]; + if (!levelInfo) { + throw new Error(`Invalid log level: ${level}`); + } + this.minLevel = levelInfo.level; /** @type {ts.FormatDiagnosticsHost} */ this.formattHost = { getCanonicalFileName: (fileName) => fileName, @@ -23,36 +31,36 @@ class DiagnosticEngine { console.log(message); } - /** - * @param {string} message - * @param {ts.Node | undefined} node - */ - info(message, node = undefined) { - this.printLog("info", '\x1b[32m', message, node); - } - - /** - * @param {string} message - * @param {ts.Node | undefined} node - */ - warn(message, node = undefined) { - this.printLog("warning", '\x1b[33m', message, node); - } - - /** - * @param {string} message - */ - error(message) { - this.printLog("error", '\x1b[31m', message); + static LEVELS = { + "verbose": { + color: '\x1b[34m', + level: 0, + }, + "info": { + color: '\x1b[32m', + level: 1, + }, + "warning": { + color: '\x1b[33m', + level: 2, + }, + "error": { + color: '\x1b[31m', + level: 3, + }, } /** - * @param {string} level - * @param {string} color + * @param {keyof typeof DiagnosticEngine.LEVELS} level * @param {string} message * @param {ts.Node | undefined} node */ - printLog(level, color, message, node = undefined) { + print(level, message, node = undefined) { + const levelInfo = DiagnosticEngine.LEVELS[level]; + if (levelInfo.level < this.minLevel) { + return; + } + const color = levelInfo.color; if (node) { const sourceFile = node.getSourceFile(); const { line, character } = sourceFile.getLineAndCharacterOfPosition(node.getStart()); @@ -85,7 +93,11 @@ export function main(args) { project: { type: 'string', short: 'p', - } + }, + "log-level": { + type: 'string', + default: 'info', + }, }, allowPositionals: true }) @@ -102,9 +114,9 @@ export function main(args) { } const filePath = options.positionals[0]; - const diagnosticEngine = new DiagnosticEngine(); + const diagnosticEngine = new DiagnosticEngine(options.values["log-level"] || "info"); - diagnosticEngine.info(`Processing ${filePath}...`); + diagnosticEngine.print("verbose", `Processing ${filePath}...`); // Create TypeScript program and process declarations const configFile = ts.readConfigFile(tsconfigPath, ts.sys.readFile); diff --git a/Plugins/BridgeJS/Sources/JavaScript/src/processor.js b/Plugins/BridgeJS/Sources/JavaScript/src/processor.js index e3887b3c..d4c72d28 100644 --- a/Plugins/BridgeJS/Sources/JavaScript/src/processor.js +++ b/Plugins/BridgeJS/Sources/JavaScript/src/processor.js @@ -16,8 +16,7 @@ import ts from 'typescript'; /** * @typedef {{ - * warn: (message: string, node?: ts.Node) => void, - * error: (message: string, node?: ts.Node) => void, + * print: (level: "warning" | "error", message: string, node?: ts.Node) => void, * }} DiagnosticEngine */ @@ -97,7 +96,7 @@ export class TypeProcessor { } }); } catch (error) { - this.diagnosticEngine.error(`Error processing ${sourceFile.fileName}: ${error.message}`); + this.diagnosticEngine.print("error", `Error processing ${sourceFile.fileName}: ${error.message}`); } } @@ -383,7 +382,7 @@ export class TypeProcessor { const typeName = this.deriveTypeName(type); if (!typeName) { - this.diagnosticEngine.warn(`Unknown non-nominal type: ${typeString}`, node); + this.diagnosticEngine.print("warning", `Unknown non-nominal type: ${typeString}`, node); return { "jsObject": {} }; } this.seenTypes.set(type, node); diff --git a/Plugins/PackageToJS/Sources/PackageToJS.swift b/Plugins/PackageToJS/Sources/PackageToJS.swift index 2b8b4458..43e2c244 100644 --- a/Plugins/PackageToJS/Sources/PackageToJS.swift +++ b/Plugins/PackageToJS/Sources/PackageToJS.swift @@ -569,8 +569,8 @@ struct PackagingPlanner { "BridgeJS is still an experimental feature. Set the environment variable JAVASCRIPTKIT_EXPERIMENTAL_BRIDGEJS=1 to enable." ) } - let bridgeJs = outputDir.appending(path: "bridge.js") - let bridgeDts = outputDir.appending(path: "bridge.d.ts") + let bridgeJs = outputDir.appending(path: "bridge-js.js") + let bridgeDts = outputDir.appending(path: "bridge-js.d.ts") packageInputs.append( make.addTask(inputFiles: exportedSkeletons + importedSkeletons, output: bridgeJs) { _, scope in let link = try BridgeJSLink( diff --git a/Plugins/PackageToJS/Templates/instantiate.d.ts b/Plugins/PackageToJS/Templates/instantiate.d.ts index 2cf956e5..e42e4f2f 100644 --- a/Plugins/PackageToJS/Templates/instantiate.d.ts +++ b/Plugins/PackageToJS/Templates/instantiate.d.ts @@ -1,8 +1,8 @@ import type { /* #if USE_SHARED_MEMORY */SwiftRuntimeThreadChannel, /* #endif */SwiftRuntime } from "./runtime.js"; /* #if HAS_BRIDGE */ -export type { Imports, Exports } from "./bridge.js"; -import type { Imports, Exports } from "./bridge.js"; +export type { Imports, Exports } from "./bridge-js.js"; +import type { Imports, Exports } from "./bridge-js.js"; /* #else */ export type Imports = {} export type Exports = {} diff --git a/Plugins/PackageToJS/Templates/instantiate.js b/Plugins/PackageToJS/Templates/instantiate.js index 4a3a3222..65996d86 100644 --- a/Plugins/PackageToJS/Templates/instantiate.js +++ b/Plugins/PackageToJS/Templates/instantiate.js @@ -15,7 +15,7 @@ export const MEMORY_TYPE = { /* #if HAS_BRIDGE */ // @ts-ignore -import { createInstantiator } from "./bridge.js" +import { createInstantiator } from "./bridge-js.js" /* #else */ /** * @param {import('./instantiate.d').InstantiateOptions} options diff --git a/Sources/JavaScriptKit/Documentation.docc/Articles/Ahead-of-Time-Code-Generation.md b/Sources/JavaScriptKit/Documentation.docc/Articles/Ahead-of-Time-Code-Generation.md index 755f68b9..e3f52885 100644 --- a/Sources/JavaScriptKit/Documentation.docc/Articles/Ahead-of-Time-Code-Generation.md +++ b/Sources/JavaScriptKit/Documentation.docc/Articles/Ahead-of-Time-Code-Generation.md @@ -44,7 +44,15 @@ let package = Package( ) ``` -### Step 2: Create Your Swift Code with @JS Annotations +### Step 2: Create BridgeJS Configuration + +Create a `bridge-js.config.json` file in your SwiftPM target directory you want to use BridgeJS. + +```console +$ echo "{}" > Sources/MyApp/bridge-js.config.json +``` + +### Step 3: Create Your Swift Code with @JS Annotations Write your Swift code with `@JS` annotations as usual: @@ -70,12 +78,12 @@ import JavaScriptKit } ``` -### Step 3: Create Your TypeScript Definitions +### Step 4: Create Your TypeScript Definitions -If you're importing JavaScript APIs, create your `bridge.d.ts` file as usual: +If you're importing JavaScript APIs, create your `bridge-js.d.ts` file as usual: ```typescript -// Sources/MyApp/bridge.d.ts +// Sources/MyApp/bridge-js.d.ts export function consoleLog(message: string): void; export interface Document { @@ -86,7 +94,7 @@ export interface Document { export function getDocument(): Document; ``` -### Step 4: Generate the Bridge Code +### Step 5: Generate the Bridge Code Run the command plugin to generate the bridge code: @@ -108,7 +116,7 @@ Sources/MyApp/Generated/ImportTS.swift # Generated code for TypeScript impor Sources/MyApp/Generated/JavaScript/ # Generated JSON skeletons ``` -### Step 5: Add Generated Files to Version Control +### Step 6: Add Generated Files to Version Control Add these generated files to your version control system: @@ -117,7 +125,7 @@ git add Sources/MyApp/Generated git commit -m "Add generated BridgeJS code" ``` -### Step 6: Build Your Package +### Step 7: Build Your Package Now you can build your package as usual: diff --git a/Sources/JavaScriptKit/Documentation.docc/Articles/Importing-TypeScript-into-Swift.md b/Sources/JavaScriptKit/Documentation.docc/Articles/Importing-TypeScript-into-Swift.md index 5f9bb4a1..98a9c80c 100644 --- a/Sources/JavaScriptKit/Documentation.docc/Articles/Importing-TypeScript-into-Swift.md +++ b/Sources/JavaScriptKit/Documentation.docc/Articles/Importing-TypeScript-into-Swift.md @@ -51,7 +51,7 @@ let package = Package( ### Step 2: Create TypeScript Definitions -Create a file named `bridge.d.ts` in your target source directory (e.g. `Sources//bridge.d.ts`). This file defines the JavaScript APIs you want to use in Swift: +Create a file named `bridge-js.d.ts` in your target source directory (e.g. `Sources//bridge-js.d.ts`). This file defines the JavaScript APIs you want to use in Swift: ```typescript // Simple function diff --git a/Tests/BridgeJSRuntimeTests/bridge-js.config.json b/Tests/BridgeJSRuntimeTests/bridge-js.config.json new file mode 100644 index 00000000..9e26dfee --- /dev/null +++ b/Tests/BridgeJSRuntimeTests/bridge-js.config.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/Tests/BridgeJSRuntimeTests/bridge.d.ts b/Tests/BridgeJSRuntimeTests/bridge-js.d.ts similarity index 100% rename from Tests/BridgeJSRuntimeTests/bridge.d.ts rename to Tests/BridgeJSRuntimeTests/bridge-js.d.ts diff --git a/Tests/prelude.mjs b/Tests/prelude.mjs index 38586296..a1af2a76 100644 --- a/Tests/prelude.mjs +++ b/Tests/prelude.mjs @@ -35,7 +35,7 @@ export function setupOptions(options, context) { import assert from "node:assert"; -/** @param {import('./../.build/plugins/PackageToJS/outputs/PackageTests/bridge.d.ts').Exports} exports */ +/** @param {import('./../.build/plugins/PackageToJS/outputs/PackageTests/bridge-js.d.ts').Exports} exports */ function BridgeJSRuntimeTests_runJsWorks(instance, exports) { exports.roundTripVoid(); for (const v of [0, 1, -1, 2147483647, -2147483648]) {