feat: CodingKeyIgnored

Author: winddpan

README.md

@@ -1,9 +1,9 @@
 # Requirements
 
-| Xcode     | Minimun Deployments | Version                                                        |
-| --------- | ------------------- | -------------------------------------------------------------- |
-| Xcode15+   | iOS13+ / macOS11+  | 1.0+                                                           |
-| < Xcode15 |  < iOS13 / macOS11   | [0.3.3](https://github.com/winddpan/CodableWrapper/tree/0.3.3) |
+| Xcode    | Minimun Deployments | Version                                                        |
+| -------- | ------------------- | -------------------------------------------------------------- |
+| Xcode15+ | iOS13+ / macOS11+   | 1.0+                                                           |
+| Xcode15- | iOS13- / macOS11-   | [0.3.3](https://github.com/winddpan/CodableWrapper/tree/0.3.3) |
 
 # About
 
@@ -22,9 +22,11 @@ The project objective is to enhance the usage experience of the Codable protocol
 ## Installation
 
 #### CocoaPods
+
 ``` pod 'CodableWrapper', :git => 'https://github.com/winddpan/CodableWrapper.git' ```
 
 #### Swift Package Manager
+
 ``` https://github.com/winddpan/CodableWrapper ```
 
 # Example
@@ -151,6 +153,15 @@ final class CodableWrapperTests: XCTestCase {
       }
   }
   ```
+  
+  ```swift
+  @Codable(wiseInit: false)
+  public struct TestModel {
+      public var userName: String = ""
+  
+      // Disable WiseInit Automatic generated
+  }
+  ```
 
 ## @CodingKey
 
@@ -166,6 +177,20 @@ final class CodableWrapperTests: XCTestCase {
   // { "u9": "jhon" }
   ```
 
+## @CodingKeyIgnored
+
+- Ignored propery on encode and decode
+  
+  ```swift
+  struct NonCodable {}
+  
+  @Codable
+  struct TestModel {
+      @CodingKeyIgnored
+      var nonCodable: NonCodable?
+  }
+  ```
+
 ## @CodingNestedKey
 
 * Custom `CodingKey`s in `nested dictionary`

Sources/CodableWrapper/CodableWrapperMacros.swift

@@ -8,6 +8,9 @@ public macro CodableSubclass() = #externalMacro(module: "CodableWrapperMacros",
 @attached(peer)
 public macro CodingKey(_ key: String ...) = #externalMacro(module: "CodableWrapperMacros", type: "CodingKey")
 
+@attached(peer)
+public macro CodingKeyIgnored() = #externalMacro(module: "CodableWrapperMacros", type: "CodingKeyIgnored")
+
 @attached(peer)
 public macro CodingNestedKey(_ key: String ...) = #externalMacro(module: "CodableWrapperMacros", type: "CodingNestedKey")
 

Sources/CodableWrapperMacros/CodingKeyIgnored.swift

@@ -0,0 +1,8 @@
+import SwiftSyntax
+import SwiftSyntaxMacros
+
+public struct CodingKeyIgnored: PeerMacro {
+    public static func expansion(of node: AttributeSyntax, providingPeersOf declaration: some DeclSyntaxProtocol, in context: some MacroExpansionContext) throws -> [DeclSyntax] {
+        return []
+    }
+}

Sources/CodableWrapperMacros/ModelMemberPropertyContainer.swift

@@ -208,17 +208,24 @@ private extension ModelMemberPropertyContainer {
             let names = patterns.compactMap { $0.as(IdentifierPatternSyntax.self)?.identifier.text }
 
             return try names.compactMap { name -> ModelMemberProperty? in
+                let attributes = variable.attributes
+
                 guard !variable.isLazyVar else {
                     return nil
                 }
                 guard let type = variable.inferType else {
                     throw ASTError("please declare property type: \(name)")
                 }
 
+                // CodingKeyIgnored
+                if let _ = attributes.first(where: { element in
+                    element.as(AttributeSyntax.self)?.attributeName.as(IdentifierTypeSyntax.self)?.description == "CodingKeyIgnored"
+                }) {
+                    return nil
+                }
+
                 var mp = ModelMemberProperty(name: name, type: type)
                 mp.modifiers = variable.modifiers
-                let attributes = variable.attributes
-
                 // isOptional
                 mp.isOptional = variable.isOptionalType
 

Sources/CodableWrapperMacros/Plugin.swift

@@ -7,6 +7,7 @@ struct CodableWrapperPlugin: CompilerPlugin {
         Codable.self,
         CodableSubclass.self,
         CodingKey.self,
+        CodingKeyIgnored.self,
         CodingNestedKey.self,
         CodingTransformer.self,
     ]

Tests/CodableWrapperTests/ExampleTest.swift

@@ -14,8 +14,13 @@ enum Animal: String, Codable {
     case fish
 }
 
+struct NonCodable {}
+
 @Codable
 struct ExampleModel: Codable {
+    @CodingKeyIgnored
+    var nonCodable: NonCodable?
+    
     @CodingKey("aString")
     var stringVal: String = "scyano"