Rename Flat to FlatCoding

Author: vnixx

README.md

@@ -52,7 +52,7 @@ Main features include:
 - Support flexible type conversion between basic data types like `Bool`, `String`, `Double`, `Int`, `CGFloat` through `@FlexibleType`
 - Support BigInt `Int128`, `UInt128` on macOS 15+, iOS 13+
 - Support encoding/decoding of `Any` through `AnyCodable`, like `var dict = [String: AnyCodable]`
-- Flatten nested property into the parent structure during coding using `@Flat`
+- Flatten nested property into the parent structure during coding using `@FlatCoding`
 - Auto-generate default instances: 
   Use `@DefaultInstance` to automatically create a default instance of your type, 
   accessible through `Model.default`
@@ -922,7 +922,7 @@ struct User3: Equatable {
 }
 ```
 
-### 21. Flatten Property with `@Flat`
+### 21. Flatten Property with `@FlatCoding`
 
 Flatten a nested property so that its fields are encoded/decoded at the same level as the enclosing type.
 
@@ -932,7 +932,7 @@ struct User {
     var name: String
     var age: Int = 0
 
-    @Flat
+    @FlatCoding
     var address: Address
 }
 

README_CN.md

@@ -47,7 +47,7 @@ ReerCodable 框架提供了一系列自定义宏，用于生成动态的 Codable
 - 通过 `@FlexibleType` 支持 `Bool`, `String`, `Double`, `Int`, `CGFloat` 等基本数据类型互相转换
 - 支持 BigInt `Int128`, `UInt128` (限 macOS 15+, iOS 13+)
 - 支持通过 `AnyCodable` 来实现对 `Any` 的编解码, 如 `var dict = [String: AnyCodable]`
-- 使用 `@Flat` 在编解码时将嵌套属性“拍平”到父级结构
+- 使用 `@FlatCoding` 在编解码时将嵌套属性“拍平”到父级结构
 - 支持通过 `@DefaultInstance` 生成一个 `static let default: Model` 实例, `Model.default`
 - 支持通过 `@Copyable` 生成 `copy()` 方法, 并且支持部分属性值的 update
 - 自动生成默认实例：使用 `@DefaultInstance` 自动创建类型的默认实例, 可通过 Model.default 访问
@@ -917,7 +917,7 @@ struct User3: Equatable {
 }
 ```
 
-### 21. 使用 `@Flat` 扁平化属性
+### 21. 使用 `@FlatCoding` 扁平化属性
 
 将某个嵌套属性在编解码时“拍平”，使其字段与父类型位于同一层级进行编码/解码。
 
@@ -927,7 +927,7 @@ struct User {
     var name: String
     var age: Int = 0
 
-    @Flat
+    @FlatCoding
     var address: Address
 }
 

…ReerCodable/MacroDeclarations/Flat.swift …dable/MacroDeclarations/FlatCoding.swiftSources/ReerCodable/MacroDeclarations/Flat.swift renamed to Sources/ReerCodable/MacroDeclarations/FlatCoding.swift Sources/ReerCodable/MacroDeclarations/Flat.swift renamed to Sources/ReerCodable/MacroDeclarations/FlatCoding.swift

@@ -19,7 +19,7 @@
 //  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 //  THE SOFTWARE.
 
-/// The `@Flat` macro flattens a property during encoding and decoding.
+/// The `@FlatCoding` macro flattens a property during encoding and decoding.
 ///
 /// When applied to a property:
 /// - Decoding: The property's value is decoded from the same decoder as the enclosing type
@@ -35,7 +35,7 @@
 ///     var name: String
 ///     var age: Int = 0
 ///
-///     @Flat
+///     @FlatCoding
 ///     var address: Address
 /// }
 ///
@@ -59,6 +59,11 @@
 /// - Can only be applied to a stored property.
 /// - Cannot be used together with any other macros on the same property; otherwise an error is thrown.
 @attached(peer)
-public macro Flat() = #externalMacro(module: "ReerCodableMacros", type: "Flat")
+public macro FlatCoding() = #externalMacro(module: "ReerCodableMacros", type: "FlatCoding")
+
+/// Deprecated: Use `@FlatCoding` instead.
+@available(*, deprecated, renamed: "FlatCoding")
+@attached(peer)
+public macro Flat() = #externalMacro(module: "ReerCodableMacros", type: "FlatCoding")
 
 

…cros/MacroImplementations/FlatImpl.swift …acroImplementations/FlatCodingImpl.swiftSources/ReerCodableMacros/MacroImplementations/FlatImpl.swift renamed to Sources/ReerCodableMacros/MacroImplementations/FlatCodingImpl.swift Sources/ReerCodableMacros/MacroImplementations/FlatImpl.swift renamed to Sources/ReerCodableMacros/MacroImplementations/FlatCodingImpl.swift

@@ -22,20 +22,20 @@
 import SwiftSyntax
 import SwiftSyntaxMacros
 
-public struct Flat: PeerMacro {
+public struct FlatCoding: PeerMacro {
     public static func expansion(
         of node: AttributeSyntax,
         providingPeersOf declaration: some DeclSyntaxProtocol,
         in context: some MacroExpansionContext
     ) throws -> [DeclSyntax] {
         guard let variableDecl = declaration.as(VariableDeclSyntax.self) else {
-            throw MacroError(text: "@Flat macro is only for a stored property.")
+            throw MacroError(text: "@FlatCoding macro is only for a stored property.")
         }
         let attributes = variableDecl.attributes.compactMap { attr in
             attr.as(AttributeSyntax.self)?.attributeName.as(IdentifierTypeSyntax.self)?.name.text
         }
-        if attributes.contains(where: { $0 != "Flat" }) {
-            throw MacroError(text: "@Flat cannot be used together with other macros on the same property.")
+        if attributes.contains(where: { $0 != "FlatCoding" && $0 != "Flat" }) {
+            throw MacroError(text: "@FlatCoding cannot be used together with other macros on the same property.")
         }
         return []
     }

Sources/ReerCodableMacros/Plugins.swift

@@ -57,7 +57,7 @@ struct ReerCodablePlugin: CompilerPlugin {
         DecodingDefault.self,
         EncodingDefault.self,
         CodingDefault.self,
-        Flat.self,
+        FlatCoding.self,
         Base64Coding.self,
         DateCoding.self,
         CompactDecoding.self,

Sources/ReerCodableMacros/TypeInfo.swift

@@ -321,7 +321,8 @@ extension TypeInfo {
                 }
 
                 // flat
-                if variable.attributes.containsAttribute(named: "Flat") {
+                if variable.attributes.containsAttribute(named: "FlatCoding")
+                    || variable.attributes.containsAttribute(named: "Flat") {
                     property.isFlat = true
                 }
 

Tests/ReerCodableTests/PropertyListCodingTests.swift

@@ -85,7 +85,7 @@ struct PlistAddress {
 struct PlistFlatModel {
     var name: String
 
-    @Flat
+    @FlatCoding
     var address: PlistAddress
 }
 

Tests/ReerCodableTests/ReerCodableTests.swift

@@ -350,7 +350,7 @@ struct FlatUser {
     var name: String
     var age: Int = 0
 
-    @Flat
+    @FlatCoding
     var address: FlatAddress
 }