Merge branch 'develop'

lukepistrol · Jun 14, 2023 · 65aad4e · 65aad4e
2 parents b3b000b + baeaae6
commit 65aad4e
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -33,6 +33,7 @@ enum Symbols: String {
     case circle
     case circleFill = "circle.fill"
     case shareIcon = "square.and.arrow.up"
+    case globe
 }
 ```
 
@@ -53,6 +54,7 @@ enum Symbols: String {
     case circle
     case circleFill = "circle.fill"
     case shareIcon = "square.and.arrow.up"
+    case globe
 
     var image: Image {
         Image(systemName: self.rawValue)
@@ -78,7 +80,9 @@ In your code you can then call a symbol:
 var body: some View {
     VStack {
         Symbols.circleFill.image
-        Text("Hello, World!)
+        Label("Globe", systemImage: Symbols.globe.name)
+        // the above can also be written as
+        Label("Globe", systemImage: Symbols.globe())
     }
 }
 ```

diff --git a/Sources/SFSymbolsMacro/SFSymbol.swift b/Sources/SFSymbolsMacro/SFSymbol.swift
@@ -4,5 +4,28 @@
 //
 //  Created by Lukas Pistrol on 14.06.23.
 //
+
+/**
+ A Swift macro for *"type-safe"* SF Symbols.
+
+ ## Initialization
+ ```swift
+ @SFSymbol
+ enum Symbols: String {
+   case globe
+   case circleFill = "circle.fill"
+ }
+ ```
+
+ ## Usage
+ ```swift
+ var body: some View {
+   Symbols.circleFill.image // ~= Image(systemName: "circle.fill")
+   Label("Globe", systemImage: Symbols.globe.name) // ~= Label("Globe", systemImage: "globe")
+   // the above can also be written as
+   Label("Globe", systemImage: Symbols.globe())
+ }
+ ```
+ */
 @attached(member, names: arbitrary)
 public macro SFSymbol() = #externalMacro(module: "SFSymbolsMacroImpl", type: "SFSymbolMacro")
diff --git a/Sources/SFSymbolsMacroImpl/SFSymbolsMacro.swift b/Sources/SFSymbolsMacroImpl/SFSymbolsMacro.swift
@@ -43,6 +43,11 @@ public struct SFSymbolMacro: MemberMacro {
                 return NSImage(systemSymbolName: self.rawValue, accessibilityDescription: accessibilityDescription)!
             }
             #endif
+            """,
+            """
+            func callAsFunction() -> String {
+                return self.rawValue
+            }
             """
         ]
     }

diff --git a/Tests/SFSymbolsMacroTests/SFSymbolsMacroTests.swift b/Tests/SFSymbolsMacroTests/SFSymbolsMacroTests.swift
@@ -39,6 +39,9 @@ final class SFSymbolsMacroTests: XCTestCase {
                     return NSImage(systemSymbolName: self.rawValue, accessibilityDescription: accessibilityDescription)!
                 }
                 #endif
+                func callAsFunction() -> String {
+                    return self.rawValue
+                }
             }
             """,
             macros: testMacros
@@ -66,4 +69,26 @@ final class SFSymbolsMacroTests: XCTestCase {
             macros: testMacros
         )
     }
+
+    func testInvalidSFSymbolErrorExplicit() {
+        assertMacroExpansion(
+            """
+            @SFSymbol
+            enum Symbols: String {
+                case xyz = "xyz"
+            }
+            """,
+            expandedSource:
+            """
+
+            enum Symbols: String {
+                case xyz = "xyz"
+            }
+            """,
+            diagnostics: [
+                .init(message: "\"xyz\" is not a valid SF Symbol.", line: 3, column: 5)
+            ],
+            macros: testMacros
+        )
+    }
 }