Merge pull request #416 from swiftwasm/yt/rename-which-override-env-format

BridgeJS: Add configuration support with bridge-js.config.json files

Author: kateinoigakukun

.gitignore

@@ -12,3 +12,4 @@ Examples/*/package-lock.json
 Package.resolved
 Plugins/BridgeJS/Sources/JavaScript/package-lock.json
 Plugins/BridgeJS/Tests/BridgeJSToolTests/__Snapshots__/**/*.actual
+bridge-js.config.local.json

Examples/ImportTS/Package.swift

@@ -5,7 +5,7 @@ import PackageDescription
 let package = Package(
     name: "MyApp",
     platforms: [
-        .macOS(.v10_15),
+        .macOS(.v11),
         .iOS(.v13),
         .tvOS(.v13),
         .watchOS(.v6),

Examples/ImportTS/Sources/main.swift

@@ -2,25 +2,25 @@ import JavaScriptKit
 
 // This function is automatically generated by the @JS plugin
 // It demonstrates how to use TypeScript functions and types imported from bridge-js.d.ts
-@JS public func run() {
+@JS public func run() throws(JSException) {
     // Call the imported consoleLog function defined in bridge-js.d.ts
-    consoleLog("Hello, World!")
+    try consoleLog("Hello, World!")
 
     // Get the document object - this comes from the imported getDocument() function
-    let document = getDocument()
+    let document = try getDocument()
 
     // Access and modify properties - the title property is read/write
-    document.title = "Hello, World!"
+    try document.setTitle("Hello, World!")
 
     // Access read-only properties - body is defined as readonly in TypeScript
-    let body = document.body
+    let body = try document.body
 
     // Create a new element using the document.createElement method
-    let h1 = document.createElement("h1")
+    let h1 = try document.createElement("h1")
 
     // Set properties on the created element
-    h1.innerText = "Hello, World!"
+    try h1.setInnerText("Hello, World!")
 
     // Call methods on objects - appendChild is defined in the HTMLElement interface
-    body.appendChild(h1)
+    try body.appendChild(h1)
 }

Examples/PlayBridgeJS/Sources/PlayBridgeJS/bridge-js.config.json

@@ -0,0 +1 @@
+{}

Plugins/BridgeJS/Sources/BridgeJSBuildPlugin/BridgeJSBuildPlugin.swift

@@ -79,6 +79,8 @@ struct BridgeJSBuildPlugin: BuildToolPlugin {
             executable: try context.tool(named: "BridgeJSTool").url,
             arguments: [
                 "import",
+                "--target-dir",
+                target.directoryURL.path,
                 "--output-skeleton",
                 outputSkeletonPath.path,
                 "--output-swift",

Plugins/BridgeJS/Sources/BridgeJSCommandPlugin/BridgeJSCommandPlugin.swift

@@ -127,6 +127,8 @@ extension BridgeJSCommandPlugin.Context {
             try runBridgeJSTool(
                 arguments: [
                     "import",
+                    "--target-dir",
+                    target.directoryURL.path,
                     "--output-skeleton",
                     generatedJavaScriptDirectory.appending(path: "BridgeJS.ImportTS.json").path,
                     "--output-swift",

Plugins/BridgeJS/Sources/BridgeJSCore/BridgeJSConfig.swift

@@ -0,0 +1,55 @@
+import struct Foundation.URL
+import struct Foundation.Data
+import class Foundation.FileManager
+import class Foundation.JSONDecoder
+
+/// Configuration file representation for BridgeJS.
+public struct BridgeJSConfig: Codable {
+    /// A mapping of tool names to their override paths.
+    ///
+    /// If not present, the tool will be searched for in the system PATH.
+    public var tools: [String: String]?
+
+    /// Load the configuration file from the SwiftPM package target directory.
+    ///
+    /// Files are loaded **in this order** and merged (later files override earlier ones):
+    /// 1. `bridge-js.config.json`
+    /// 2. `bridge-js.config.local.json`
+    public static func load(targetDirectory: URL) throws -> BridgeJSConfig {
+        // Define file paths in priority order: base first, then local overrides
+        let files = [
+            targetDirectory.appendingPathComponent("bridge-js.config.json"),
+            targetDirectory.appendingPathComponent("bridge-js.config.local.json"),
+        ]
+
+        var config = BridgeJSConfig()
+
+        for file in files {
+            do {
+                if let loaded = try loadConfig(from: file) {
+                    config = config.merging(overrides: loaded)
+                }
+            } catch {
+                throw BridgeJSCoreError("Failed to parse \(file.path): \(error)")
+            }
+        }
+
+        return config
+    }
+
+    /// Load a config file from the given URL if it exists, otherwise return nil
+    private static func loadConfig(from url: URL) throws -> BridgeJSConfig? {
+        guard FileManager.default.fileExists(atPath: url.path) else {
+            return nil
+        }
+        let data = try Data(contentsOf: url)
+        return try JSONDecoder().decode(BridgeJSConfig.self, from: data)
+    }
+
+    /// Merge the current configuration with the overrides.
+    func merging(overrides: BridgeJSConfig) -> BridgeJSConfig {
+        return BridgeJSConfig(
+            tools: (tools ?? [:]).merging(overrides.tools ?? [:], uniquingKeysWith: { $1 })
+        )
+    }
+}

Plugins/BridgeJS/Sources/BridgeJSTool/BridgeJSTool.swift

@@ -3,9 +3,11 @@
 @preconcurrency import var Foundation.stderr
 @preconcurrency import struct Foundation.URL
 @preconcurrency import struct Foundation.Data
+@preconcurrency import struct Foundation.ObjCBool
 @preconcurrency import class Foundation.JSONEncoder
 @preconcurrency import class Foundation.FileManager
 @preconcurrency import class Foundation.JSONDecoder
+@preconcurrency import class Foundation.ProcessInfo
 import SwiftParser
 
 #if canImport(BridgeJSCore)
@@ -50,7 +52,7 @@ import TS2Skeleton
         do {
             try run()
         } catch {
-            printStderr("Error: \(error)")
+            printStderr("error: \(error)")
             exit(1)
         }
     }
@@ -83,6 +85,10 @@ import TS2Skeleton
                         help: "Print verbose output",
                         required: false
                     ),
+                    "target-dir": OptionRule(
+                        help: "The SwiftPM package target directory",
+                        required: true
+                    ),
                     "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",
@@ -99,6 +105,9 @@ import TS2Skeleton
             )
             let progress = ProgressReporting(verbose: doubleDashOptions["verbose"] == "true")
             var importer = ImportTS(progress: progress, moduleName: doubleDashOptions["module-name"]!)
+            let targetDirectory = URL(fileURLWithPath: doubleDashOptions["target-dir"]!)
+            let config = try BridgeJSConfig.load(targetDirectory: targetDirectory)
+            let nodePath: URL = try config.findTool("node", targetDirectory: targetDirectory)
             for inputFile in positionalArguments {
                 if inputFile.hasSuffix(".json") {
                     let sourceURL = URL(fileURLWithPath: inputFile)
@@ -109,7 +118,7 @@ import TS2Skeleton
                     importer.addSkeleton(skeleton)
                 } else if inputFile.hasSuffix(".d.ts") {
                     let tsconfigPath = URL(fileURLWithPath: doubleDashOptions["project"]!)
-                    try importer.addSourceFile(inputFile, tsconfigPath: tsconfigPath.path)
+                    try importer.addSourceFile(inputFile, tsconfigPath: tsconfigPath.path, nodePath: nodePath)
                 }
             }
 

Plugins/BridgeJS/Sources/TS2Skeleton/TS2Skeleton.swift

@@ -22,7 +22,7 @@ import BridgeJSSkeleton
 internal func which(
     _ executable: String,
     environment: [String: String] = ProcessInfo.processInfo.environment
-) throws -> URL {
+) -> URL? {
     func checkCandidate(_ candidate: URL) -> Bool {
         var isDirectory: ObjCBool = false
         let fileExists = FileManager.default.fileExists(atPath: candidate.path, isDirectory: &isDirectory)
@@ -51,13 +51,38 @@ internal func which(
             return url
         }
     }
-    throw BridgeJSCoreError("Executable \(executable) not found in PATH")
+    return nil
+}
+
+extension BridgeJSConfig {
+    /// Find a tool from the system PATH, using environment variable override, or bridge-js.config.json
+    public func findTool(_ name: String, targetDirectory: URL) throws -> URL {
+        if let tool = tools?[name] {
+            return URL(fileURLWithPath: tool)
+        }
+        if let url = which(name) {
+            return url
+        }
+
+        // Emit a helpful error message with a suggestion to create a local config override.
+        throw BridgeJSCoreError(
+            """
+            Executable "\(name)" not found in PATH. \
+            Hint: Try setting the JAVASCRIPTKIT_\(name.uppercased().replacingOccurrences(of: "-", with: "_"))_EXEC environment variable, \
+            or create a local config override with:
+              echo '{ "tools": { "\(name)": "'$(which \(name))'" } }' > \(targetDirectory.appendingPathComponent("bridge-js.config.local.json").path)
+            """
+        )
+    }
 }
 
 extension ImportTS {
     /// Processes a TypeScript definition file and extracts its API information
-    public mutating func addSourceFile(_ sourceFile: String, tsconfigPath: String) throws {
-        let nodePath = try which("node")
+    public mutating func addSourceFile(
+        _ sourceFile: String,
+        tsconfigPath: String,
+        nodePath: URL
+    ) throws {
         let ts2skeletonPath = URL(fileURLWithPath: #filePath)
             .deletingLastPathComponent()
             .appendingPathComponent("JavaScript")

Plugins/BridgeJS/Tests/BridgeJSToolTests/BridgeJSLinkTests.swift

@@ -4,6 +4,7 @@ import SwiftParser
 import Testing
 @testable import BridgeJSLink
 @testable import BridgeJSCore
+@testable import TS2Skeleton
 
 @Suite struct BridgeJSLinkTests {
     private func snapshot(
@@ -65,7 +66,8 @@ import Testing
         let tsconfigPath = url.deletingLastPathComponent().appendingPathComponent("tsconfig.json")
 
         var importTS = ImportTS(progress: .silent, moduleName: "TestModule")
-        try importTS.addSourceFile(url.path, tsconfigPath: tsconfigPath.path)
+        let nodePath = try #require(which("node"))
+        try importTS.addSourceFile(url.path, tsconfigPath: tsconfigPath.path, nodePath: nodePath)
         let name = url.deletingPathExtension().deletingPathExtension().lastPathComponent
 
         let encoder = JSONEncoder()