doc: added tutorials for common strategies

Author: soumyamahunt

README.md

@@ -14,7 +14,7 @@ Supercharge `Swift`'s `Codable` implementations with macros.
 
 ## Overview
 
-`MetaCodable` framework exposes custom macros which can be used to generate dynamic `Codable` implementations. The core of the framework is ``Codable()`` macro which generates the implementation aided by data provided with using other macros.
+`MetaCodable` framework exposes custom macros which can be used to generate dynamic `Codable` implementations. The core of the framework is ``Codable(commonStrategies:)`` macro which generates the implementation aided by data provided with using other macros.
 
 `MetaCodable` aims to supercharge your `Codable` implementations by providing these inbox features:
 
@@ -24,6 +24,7 @@ Supercharge `Swift`'s `Codable` implementations with macros.
 - Allows to read data from additional fallback `CodingKey`s provided with ``CodedAs(_:_:)``.
 - Allows to provide default value in case of decoding failures with ``Default(_:)``, or only in case of failures when missing value with ``Default(ifMissing:)``. Different default values can also be used for value missing and other errors respectively with ``Default(ifMissing:forErrors:)``.
 - Allows to create custom decoding/encoding strategies with ``HelperCoder`` and using them with ``CodedBy(_:)``, ``CodedBy(_:properties:)`` or others. i.e. ``LossySequenceCoder`` etc.
+- Allows applying common strategies like `ValueCoder` to all properties of a type through the ``Codable(commonStrategies:)`` parameter, reducing the need for repetitive property annotations.
 - Allows specifying different case values with ``CodedAs(_:_:)`` and case value/protocol type identifier type different from `String` with ``CodedAs()``.
 - Allows specifying enum-case/protocol type identifier path with ``CodedAt(_:)`` and case content path with ``ContentAt(_:_:)``.
 - Allows decoding/encoding enums that lack distinct identifiers for each case data with ``UnTagged()``.

Sources/MetaCodable/Codable/Codable.swift

@@ -67,12 +67,12 @@ public macro Codable(commonStrategies: [CodableCommonStrategy] = []) =
 
 /// Indicates whether super class conforms to `Codable` or not.
 ///
-/// By default, ``Codable()`` assumes class inherits `Decodable`
+/// By default, ``Codable(commonStrategies:)`` assumes class inherits `Decodable`
 /// or `Encodable` conformance if it doesn't receive protocol needs
 /// to be conformed from the compiler. Using this macro, it can be explicitly
 /// indicated that the class doesn't inherit conformance in such cases.
 ///
-/// Following code indicates ``Codable()`` that `Item` class doesn't
+/// Following code indicates ``Codable(commonStrategies:)`` that `Item` class doesn't
 /// inherit conformance:
 /// ```swift
 /// @Codable
@@ -91,7 +91,7 @@ public macro Codable(commonStrategies: [CodableCommonStrategy] = []) =
 ///   - encodable: Whether super class conforms to `Encodable`.
 ///
 /// - Note: This macro on its own only validates if attached declaration
-///   is a class declaration. ``Codable()`` macro uses this macro
+///   is a class declaration. ``Codable(commonStrategies:)`` macro uses this macro
 ///   when generating final implementations.
 @attached(peer)
 @available(swift 5.9)

Sources/MetaCodable/Codable/CodingKeys.swift

@@ -25,7 +25,7 @@
 ///     let description: String
 /// }
 /// ```
-/// The ``Codable()`` macro generated code will transform field names
+/// The ``Codable(commonStrategies:)`` macro generated code will transform field names
 /// to snake-case in the `Codable` implementation.
 ///
 /// Similarly, for enums associated value label can be kept camel-cased while
@@ -88,10 +88,10 @@
 ///   ``CodedAt(_:)`` will remain unchanged.
 ///
 /// - Note: This macro on its own only validates if attached declaration
-///   is a variable declaration. ``Codable()`` macro uses this macro
+///   is a variable declaration. ``Codable(commonStrategies:)`` macro uses this macro
 ///   when generating final implementations.
 ///
-/// - Important: This attribute must be used combined with ``Codable()``.
+/// - Important: This attribute must be used combined with ``Codable(commonStrategies:)``.
 ///
 /// [Swift API Design Guidelines]:
 /// https://www.swift.org/documentation/api-design-guidelines/#general-conventions

Sources/MetaCodable/Codable/IgnoreCodingInitialized.swift

@@ -57,10 +57,10 @@
 /// while `notIgnored` is decoded and encoded.
 ///
 /// - Note: This macro on its own only validates if attached declaration
-///   is a variable declaration. ``Codable()`` macro uses this macro
+///   is a variable declaration. ``Codable(commonStrategies:)`` macro uses this macro
 ///   when generating final implementations.
 ///
-/// - Important: This attribute must be used combined with ``Codable()``.
+/// - Important: This attribute must be used combined with ``Codable(commonStrategies:)``.
 @attached(peer)
 @available(swift 5.9)
 public macro IgnoreCodingInitialized() =

Sources/MetaCodable/Codable/UnTagged.swift

@@ -37,7 +37,7 @@
 /// variables are successfully decoded, is chosen as the variation case value.
 ///
 /// - Note: This macro on its own only validates if attached declaration
-///   is a variable declaration. ``Codable()`` macro uses this macro
+///   is a variable declaration. ``Codable(commonStrategies:)`` macro uses this macro
 ///   when generating final implementations.
 ///
 /// - Important: This macro can only be applied to enums.

Sources/MetaCodable/CodedAs.swift

@@ -40,7 +40,7 @@
 /// - Parameter values: The values to use.
 ///
 /// - Note: This macro on its own only validates if attached declaration
-///   is a variable declaration. ``Codable()`` macro uses this macro
+///   is a variable declaration. ``Codable(commonStrategies:)`` macro uses this macro
 ///   when generating final implementations.
 ///
 /// - Important: The value type must be `String` when used in
@@ -103,7 +103,7 @@ public macro CodedAs<T: Codable & Equatable>(_ values: T, _: T...) =
 /// ```
 ///
 /// - Note: This macro on its own only validates if attached declaration
-///   is a variable declaration. ``Codable()`` macro uses this macro
+///   is a variable declaration. ``Codable(commonStrategies:)`` macro uses this macro
 ///   when generating final implementations.
 ///
 /// - Important: For each case ``CodedAs(_:_:)`` macro with values
@@ -116,7 +116,7 @@ public macro CodedAs<T: Codable & Equatable>(_ values: T, _: T...) =
 ///   type must be same as the type defined with this macro, in absence of this macro
 ///   ``DynamicCodable/IdentifierValue`` type must be `String`.
 ///
-/// - Important: This attribute must be used combined with ``Codable()``
+/// - Important: This attribute must be used combined with ``Codable(commonStrategies:)``
 ///   and ``CodedAt(_:)``.
 @attached(peer)
 @available(swift 5.9)

Sources/MetaCodable/CodedAt.swift

@@ -124,7 +124,7 @@
 /// - Parameter path: The `CodingKey` path value located at.
 ///
 /// - Note: This macro on its own only validates if attached declaration
-///   is a variable declaration. ``Codable()`` macro uses this macro
+///   is a variable declaration. ``Codable(commonStrategies:)`` macro uses this macro
 ///   when generating final implementations.
 ///
 /// - Important: When applied to fields, the field type must confirm to

Sources/MetaCodable/CodedBy.swift

@@ -14,7 +14,7 @@
 /// - Parameter helper: The value that performs decoding and encoding.
 ///
 /// - Note: This macro on its own only validates if attached declaration
-///   is a variable declaration. ``Codable()`` macro uses this macro
+///   is a variable declaration. ``Codable(commonStrategies:)`` macro uses this macro
 ///   when generating final implementations.
 ///
 /// - Important: The `helper`'s ``HelperCoder/Coded``
@@ -23,7 +23,7 @@
 /// - Important: When using with enums and protocols if ``HelperCoder/Coded``
 ///   is other than `String` type must be provided with ``CodedAs()`` macro.
 ///
-/// - Important: This attribute must be used combined with ``Codable()``
+/// - Important: This attribute must be used combined with ``Codable(commonStrategies:)``
 ///   and ``CodedAt(_:)`` when applying to enums/protocols.
 @attached(peer)
 @available(swift 5.9)
@@ -73,7 +73,7 @@ public macro CodedBy<T: HelperCoder>(_ helper: T) =
 ///   - properties: The key path to properties passed to the creation action.
 ///
 /// - Note: This macro on its own only validates if attached declaration
-///   is a variable declaration. ``Codable()`` macro uses this macro
+///   is a variable declaration. ``Codable(commonStrategies:)`` macro uses this macro
 ///   when generating final implementations.
 ///
 /// - Important: The `Parent` type must be the current `struct`/`class`/`actor`
@@ -139,7 +139,7 @@ public macro CodedBy<Parent, Helper: HelperCoder, each Property>(
 ///   - properties: The key path to properties passed to the creation action.
 ///
 /// - Note: This macro on its own only validates if attached declaration
-///   is a variable declaration. ``Codable()`` macro uses this macro
+///   is a variable declaration. ``Codable(commonStrategies:)`` macro uses this macro
 ///   when generating final implementations.
 ///
 /// - Important: The `Parent` type must be the current `struct`/`class`/`actor`
@@ -166,7 +166,7 @@ public macro CodedBy<Parent, Helper: HelperCoder, each Argument, each Property>(
 ///   - properties: The key path to properties passed to the creation action.
 ///
 /// - Note: This macro on its own only validates if attached declaration
-///   is a variable declaration. ``Codable()`` macro uses this macro
+///   is a variable declaration. ``Codable(commonStrategies:)`` macro uses this macro
 ///   when generating final implementations.
 ///
 /// - Important: The `Parent` type must be the current `struct`/`class`/`actor`
@@ -196,7 +196,7 @@ public macro CodedBy<Parent, Helper: HelperCoder, Argument1, each Property>(
 ///   - properties: The key path to properties passed to the creation action.
 ///
 /// - Note: This macro on its own only validates if attached declaration
-///   is a variable declaration. ``Codable()`` macro uses this macro
+///   is a variable declaration. ``Codable(commonStrategies:)`` macro uses this macro
 ///   when generating final implementations.
 ///
 /// - Important: The `Parent` type must be the current `struct`/`class`/`actor`
@@ -229,7 +229,7 @@ public macro CodedBy<
 ///   - properties: The key path to properties passed to the creation action.
 ///
 /// - Note: This macro on its own only validates if attached declaration
-///   is a variable declaration. ``Codable()`` macro uses this macro
+///   is a variable declaration. ``Codable(commonStrategies:)`` macro uses this macro
 ///   when generating final implementations.
 ///
 /// - Important: The `Parent` type must be the current `struct`/`class`/`actor`

Sources/MetaCodable/CodedIn.swift

@@ -31,7 +31,7 @@
 /// - Parameter path: The `CodingKey` path of container value located in.
 ///
 /// - Note: This macro on its own only validates if attached declaration
-///   is a variable declaration. ``Codable()`` macro uses this macro
+///   is a variable declaration. ``Codable(commonStrategies:)`` macro uses this macro
 ///   when generating final implementations.
 ///
 /// - Note: Providing no arguments has the same effect as not applying

Sources/MetaCodable/ContentAt.swift

@@ -47,10 +47,10 @@
 ///   protocol conforming type data located at.
 ///
 /// - Note: This macro on its own only validates if attached declaration
-///   is a variable declaration. ``Codable()`` macro uses this macro
+///   is a variable declaration. ``Codable(commonStrategies:)`` macro uses this macro
 ///   when generating final implementations.
 ///
-/// - Important: This attribute must be used combined with ``Codable()``
+/// - Important: This attribute must be used combined with ``Codable(commonStrategies:)``
 ///   and ``CodedAt(_:)``.
 @attached(peer)
 @available(swift 5.9)