Skip to content

Restrict @JSClass to structs #523

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
Jan 26, 2026
Merged

Restrict @JSClass to structs #523

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
8 changes: 8 additions & 0 deletions Plugins/BridgeJS/Sources/BridgeJSMacros/JSClassMacro.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@ extension JSClassMacro: MemberMacro {
conformingTo protocols: [TypeSyntax],
in context: some MacroExpansionContext
) throws -> [DeclSyntax] {
guard declaration.is(StructDeclSyntax.self) else {
context.diagnose(
Diagnostic(node: Syntax(declaration), message: JSMacroMessage.unsupportedJSClassDeclaration)
)
return []
}

var members: [DeclSyntax] = []

let existingMembers = declaration.memberBlock.members
Expand Down Expand Up @@ -59,6 +66,7 @@ extension JSClassMacro: ExtensionMacro {
conformingTo protocols: [TypeSyntax],
in context: some MacroExpansionContext
) throws -> [ExtensionDeclSyntax] {
guard declaration.is(StructDeclSyntax.self) else { return [] }
guard !protocols.isEmpty else { return [] }

let conformanceList = protocols.map { $0.trimmed.description }.joined(separator: ", ")
Expand Down
1 change: 1 addition & 0 deletions Plugins/BridgeJS/Sources/BridgeJSMacros/JSMacroSupport.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import SwiftDiagnostics

enum JSMacroMessage: String, DiagnosticMessage {
case unsupportedDeclaration = "@JSFunction can only be applied to functions or initializers."
case unsupportedJSClassDeclaration = "@JSClass can only be applied to structs."
case unsupportedVariable = "@JSGetter can only be applied to single-variable declarations."
case unsupportedSetterDeclaration = "@JSSetter can only be applied to functions."
case invalidSetterName =
Expand Down
45 changes: 21 additions & 24 deletions Plugins/BridgeJS/Tests/BridgeJSMacrosTests/JSClassMacroTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,16 +153,15 @@ import BridgeJSMacros
""",
expandedSource: """
class MyClass {
let jsObject: JSObject

init(unsafelyWrapping jsObject: JSObject) {
self.jsObject = jsObject
}
}

extension MyClass: _JSBridgedClass {
}
""",
diagnostics: [
DiagnosticSpec(
message: "@JSClass can only be applied to structs.",
line: 1,
column: 1
)
],
macroSpecs: macroSpecs,
indentationWidth: indentationWidth
)
Expand All @@ -177,16 +176,15 @@ import BridgeJSMacros
""",
expandedSource: """
enum MyEnum {
let jsObject: JSObject

init(unsafelyWrapping jsObject: JSObject) {
self.jsObject = jsObject
}
}

extension MyEnum: _JSBridgedClass {
}
""",
diagnostics: [
DiagnosticSpec(
message: "@JSClass can only be applied to structs.",
line: 1,
column: 1
)
],
macroSpecs: macroSpecs,
indentationWidth: indentationWidth
)
Expand All @@ -201,16 +199,15 @@ import BridgeJSMacros
""",
expandedSource: """
actor MyActor {
let jsObject: JSObject

init(unsafelyWrapping jsObject: JSObject) {
self.jsObject = jsObject
}
}

extension MyActor: _JSBridgedClass {
}
""",
diagnostics: [
DiagnosticSpec(
message: "@JSClass can only be applied to structs.",
line: 1,
column: 1
)
],
macroSpecs: macroSpecs,
indentationWidth: indentationWidth
)
Expand Down