Skip to content

BridgeJS: Export with a different JS name #801

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.

Sign up for GitHub

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

Merged
kateinoigakukun merged 1 commit into from
Aug 11, 2026
Merged

BridgeJS: Export with a different JS name #801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
88 changes: 87 additions & 1 deletion Plugins/BridgeJS/Sources/BridgeJSCore/SwiftToSkeleton.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -731,6 +731,23 @@ public final class SwiftToSkeleton {
return String(name.dropFirst().dropLast())
}

fileprivate static func isValidJSIdentifier(_ name: String) -> Bool {
func isIdentifierPart(_ scalar: Unicode.Scalar, isStart: Bool) -> Bool {
switch scalar {
case "a"..."z", "A"..."Z", "_", "$":
return true
case "0"..."9":
return !isStart
default:
return false
}
}
guard let first = name.unicodeScalars.first, isIdentifierPart(first, isStart: true) else {
return false
}
return name.unicodeScalars.dropFirst().allSatisfy { isIdentifierPart($0, isStart: false) }
}

}

private enum ExportSwiftConstants {
Expand Down Expand Up @@ -1291,6 +1308,7 @@ private final class ExportSwiftAPICollector: SyntaxAnyVisitor {
}

let name = node.name.text
let jsName = extractValidatedJSName(from: jsAttribute)

let attributeNamespace = extractNamespace(from: jsAttribute)
let computedNamespace = computeNamespace(for: node)
Expand Down Expand Up @@ -1378,7 +1396,7 @@ private final class ExportSwiftAPICollector: SyntaxAnyVisitor {
classNameForABI = nil
}
abiName = ABINameGenerator.generateABIName(
baseName: name,
baseName: jsName ?? name,
namespace: finalNamespace,
staticContext: isStatic ? staticContext : nil,
className: classNameForABI
Expand All @@ -1390,6 +1408,7 @@ private final class ExportSwiftAPICollector: SyntaxAnyVisitor {

return ExportedFunction(
name: name,
jsName: jsName,
abiName: abiName,
parameters: parameters,
returnType: returnType,
Expand Down Expand Up @@ -1469,6 +1488,45 @@ private final class ExportSwiftAPICollector: SyntaxAnyVisitor {
return Effects(isAsync: isAsync, isThrows: isThrows, isStatic: isStatic)
}

private func extractJSName(
from jsAttribute: AttributeSyntax
) -> String? {
guard let arguments = jsAttribute.arguments?.as(LabeledExprListSyntax.self),
let nameArg = arguments.first,
nameArg.label == nil,
let stringLiteral = nameArg.expression.as(StringLiteralExprSyntax.self),
stringLiteral.segments.count == 1,
let name = stringLiteral.segments.first?.as(StringSegmentSyntax.self)?.content.text
else {
return nil
}
return name
}

private func extractValidatedJSName(
from jsAttribute: AttributeSyntax
) -> String? {
guard let jsName = extractJSName(from: jsAttribute) else { return nil }
guard SwiftToSkeleton.isValidJSIdentifier(jsName) else {
diagnose(
node: jsAttribute,
message: "`\(jsName)` is not a valid JavaScript identifier"
)
return nil
}
return jsName
}

private func diagnoseUnsupportedJSName(
from jsAttribute: AttributeSyntax
) {
guard extractJSName(from: jsAttribute) != nil else { return }
diagnose(
node: jsAttribute,
message: "A separate name for JavaScript is not supported here"
)
}

private func extractNamespace(
from jsAttribute: AttributeSyntax
) -> [String]? {
Expand Down Expand Up @@ -1515,6 +1573,8 @@ private final class ExportSwiftAPICollector: SyntaxAnyVisitor {
override func visit(_ node: InitializerDeclSyntax) -> SyntaxVisitorContinueKind {
guard let jsAttribute = node.attributes.firstJSAttribute else { return .skipChildren }

diagnoseUnsupportedJSName(from: jsAttribute)

switch state {
case .classBody(_, let classKey):
if extractNamespace(from: jsAttribute) != nil {
Expand Down Expand Up @@ -1636,6 +1696,15 @@ private final class ExportSwiftAPICollector: SyntaxAnyVisitor {
}
}

let jsName = extractValidatedJSName(from: jsAttribute)
if jsName != nil, node.bindings.count > 1 {
diagnose(
node: jsAttribute,
message: "Name targets declaration with multiple bindings",
hint: "Declare each property with a different JS name separately"
)
}

// Process each binding (variable declaration)
for binding in node.bindings {
guard let pattern = binding.pattern.as(IdentifierPatternSyntax.self) else {
Expand Down Expand Up @@ -1663,6 +1732,7 @@ private final class ExportSwiftAPICollector: SyntaxAnyVisitor {

let exportedProperty = ExportedProperty(
name: propertyName,
jsName: jsName,
type: propertyType,
isReadonly: isReadonly,
isStatic: isStatic,
Expand Down Expand Up @@ -1693,6 +1763,8 @@ private final class ExportSwiftAPICollector: SyntaxAnyVisitor {
return .skipChildren
}

diagnoseUnsupportedJSName(from: jsAttribute)

if let aliasTarget = parent.extractAliasTarget(from: jsAttribute) {
recordAlias(node: node, jsAttribute: jsAttribute, aliasTarget: aliasTarget)
return .skipChildren
Expand Down Expand Up @@ -1843,6 +1915,8 @@ private final class ExportSwiftAPICollector: SyntaxAnyVisitor {
return .skipChildren
}

diagnoseUnsupportedJSName(from: jsAttribute)

if let aliasTarget = parent.extractAliasTarget(from: jsAttribute) {
recordAlias(node: node, jsAttribute: jsAttribute, aliasTarget: aliasTarget)
return .skipChildren
Expand Down Expand Up @@ -1968,6 +2042,8 @@ private final class ExportSwiftAPICollector: SyntaxAnyVisitor {
return .skipChildren
}

diagnoseUnsupportedJSName(from: jsAttribute)

let name = node.name.text

let namespaceResult = resolveNamespace(from: jsAttribute, for: node, declarationType: "protocol")
Expand Down Expand Up @@ -2031,6 +2107,8 @@ private final class ExportSwiftAPICollector: SyntaxAnyVisitor {
return .skipChildren
}

diagnoseUnsupportedJSName(from: jsAttribute)

if let aliasTarget = parent.extractAliasTarget(from: jsAttribute) {
recordAlias(node: node, jsAttribute: jsAttribute, aliasTarget: aliasTarget)
return .skipChildren
Expand Down Expand Up @@ -2169,6 +2247,10 @@ private final class ExportSwiftAPICollector: SyntaxAnyVisitor {
protocolName: String,
namespace: [String]?
) -> ExportedFunction? {
if let jsAttribute = node.attributes.firstJSAttribute {
diagnoseUnsupportedJSName(from: jsAttribute)
}

let name = node.name.text

let parameters = parseParameters(from: node.signature.parameterClause, allowDefaults: false)
Expand Down Expand Up @@ -2215,6 +2297,10 @@ private final class ExportSwiftAPICollector: SyntaxAnyVisitor {
protocolName: String,
protocolKey: String
) -> SyntaxVisitorContinueKind {
if let jsAttribute = node.attributes.firstJSAttribute {
diagnoseUnsupportedJSName(from: jsAttribute)
}

for binding in node.bindings {
guard let pattern = binding.pattern.as(IdentifierPatternSyntax.self) else {
diagnose(node: binding.pattern, message: "Complex patterns not supported for protocol properties")
Expand Down
Loading
Loading