chore: fix spell mistakes

Author: soumyamahunt

.github/config/custom-words.txt

@@ -0,0 +1,22 @@
+json
+Github
+Codable
+DynamicCodableKit
+CocoaPods
+CocoaPod
+podspec
+SPM
+DocC
+Xcode
+XCFramework
+macOS
+tvOS
+watchOS
+submodule
+automagically
+casted
+url
+png
+lossy
+enum
+struct

.github/config/spellcheck.yml

@@ -5,6 +5,9 @@ matrix:
     d: en_US
   dictionary:
     encoding: utf-8
+    wordlists:
+    - .github/config/swift-custom.txt
+    output: .build/dictionary/custom-words.dic
   pipeline:
   - pyspelling.filters.markdown:
   - pyspelling.filters.html:

CHANGELOG.md

@@ -37,5 +37,5 @@
 * add dynamic JSON decoding with type identifiers ([63bab18](https://github.com/SwiftyLab/DynamicCodableKit/commit/63bab18f80d087d9538c17b4dd8189a7fef5a6c6))
 * add dynamic JSON decoding with type(s) parent coding key ([5c5bf0a](https://github.com/SwiftyLab/DynamicCodableKit/commit/5c5bf0a2567ad21927ea7a6a2cb4bfa1ab5ed2da))
 * add dynamic JSON decoding with user context provider ([8a61ceb](https://github.com/SwiftyLab/DynamicCodableKit/commit/8a61cebe6727159e88829e0b2f41bc521d3614ce))
-* add ingrore key with invalid data for parent coding key based dynamic decoding ([b9dc92f](https://github.com/SwiftyLab/DynamicCodableKit/commit/b9dc92f90ed10287e712aed09c192b8fea7ab54e))
+* add ignore key with invalid data for parent coding key based dynamic decoding ([b9dc92f](https://github.com/SwiftyLab/DynamicCodableKit/commit/b9dc92f90ed10287e712aed09c192b8fea7ab54e))
 

README.md

@@ -40,7 +40,7 @@ The data types, protocols, and property wrappers defined by **DynamicCodableKit*
 pod 'DynamicCodableKit'
 ```
 
-Optionally, you can also use the pre built XCFramework from the GitHub releases page by replacing `{version}` with the required version you want to use:
+Optionally, you can also use the pre-built XCFramework from the GitHub releases page by replacing `{version}` with the required version you want to use:
 
 ```ruby
 pod 'DynamicCodableKit', :http => 'https://github.com/SwiftyLab/DynamicCodableKit/releases/download/v{version}/DynamicCodableKit-{version}.xcframework.zip'
@@ -64,7 +64,7 @@ Once you have your Swift package set up, adding `DynamicCodableKit` as a depende
 .package(url: "https://github.com/SwiftyLab/DynamicCodableKit.git", from: "1.0.0"),
 ```
 
-Optionally, you can also use the pre built XCFramework from the GitHub releases page by replacing `{version}` and `{checksum}` with the required version and checksum of artifact you want to use:
+Optionally, you can also use the pre-built XCFramework from the GitHub releases page by replacing `{version}` and `{checksum}` with the required version and checksum of artifact you want to use:
 
 ```swift
 .binaryTarget(name: "DynamicCodableKit", url: "https://github.com/SwiftyLab/DynamicCodableKit/releases/download/v{version}/DynamicCodableKit-{version}.xcframework.zip", checksum: "{checksum}"),
@@ -117,7 +117,7 @@ See the full [documentation](https://swiftylab.github.io/DynamicCodableKit/docum
 
 ## Contributing
 
-If you wish to contribute a change, suggest any improvementse,
+If you wish to contribute a change, suggest any improvements,
 please review our [contribution guide](CONTRIBUTING.md),
 check for open [issues](https://github.com/SwiftyLab/DynamicCodableKit/issues), if it is already being worked upon
 or open a [pull request](https://github.com/SwiftyLab/DynamicCodableKit/pulls).

Sources/DynamicCodableKit/DynamicCodableKit.docc/Extensions/DynamicDecodable.md

@@ -4,7 +4,7 @@
     @DocumentationExtension(mergeBehavior: append)
 }
 
-Provides `castAs` methods to customise dynamic casting to a provided type where provided type can be optional type or collection type as well. Default implementations are provided to work well with down casting, however custom types can provide their own casting behavior.
+Provides `castAs` methods to customize dynamic casting to a provided type where provided type can be optional type or collection type as well. Default implementations are provided to work well with down casting, however custom types can provide their own casting behavior.
 
 For example, in <doc:TypeIdentifier>, to use `Set` of `Post` type instead of `Array`, a box type for `Post` type can be created that will confirm `Hashable`:
 ```swift

Sources/DynamicCodableKit/DynamicCodableKit.docc/Guides/CollectionDecoding.md

@@ -10,9 +10,9 @@ These wrappers accept ``DynamicDecodingCollectionConfigurationProvider`` that pr
 
 Implementation for all the configuration scenarios are provided with type aliases, depending upon following naming convention.
 
-- Alases starting with `Strict..` indicate the if decoding fails then error is thrown.
-- Alases starting with `DefaultValue..` indicate that in the event of decoding fail, empty collection is used.
-- Alases starting with `Lossy..` provide safest decoding configuration. Each item in collection is decoded one by one, if the data for item is intact and valid item is added to collection, otherwise item is ignored.
+- Aliases starting with `Strict..` indicate the if decoding fails then error is thrown.
+- Aliases starting with `DefaultValue..` indicate that in the event of decoding fail, empty collection is used.
+- Aliases starting with `Lossy..` provide safest decoding configuration. Each item in collection is decoded one by one, if the data for item is intact and valid item is added to collection, otherwise item is ignored.
 
 In the <doc:TypeIdentifier> topic, ``StrictDynamicDecodingArrayWrapper`` will throw error decoding following response, while, ``DefaultValueDynamicDecodingArrayWrapper`` will decode an empty array and ``LossyDynamicDecodingArrayWrapper`` will ignore first two items and only decode the last item.
 ```json
@@ -33,7 +33,7 @@ In the <doc:TypeIdentifier> topic, ``StrictDynamicDecodingArrayWrapper`` will th
       "createdAt": "2021-07-23T09:36:38Z",
       "url": "https://a.url.com/to/a/video.mp4",
       "duration": 460,
-      "thumbnail": "https://a.url.com/to/a/thmbnail.png"
+      "thumbnail": "https://a.url.com/to/a/thumbnail.png"
     },
     {
       "id": "98765432-abcd-efab-0123-456789abcdef",
@@ -43,7 +43,7 @@ In the <doc:TypeIdentifier> topic, ``StrictDynamicDecodingArrayWrapper`` will th
       "createdAt": "2021-07-23T09:36:38Z",
       "url": "https://a.url.com/to/a/video.mp4",
       "duration": 460,
-      "thumbnail": "https://a.url.com/to/a/thmbnail.png"
+      "thumbnail": "https://a.url.com/to/a/thumbnail.png"
     }
   ],
   "next": "https://a.url.com/to/next/page"

Sources/DynamicCodableKit/DynamicCodableKit.docc/Guides/ContainerCodingKey.md

@@ -49,7 +49,7 @@ Alternative to <doc:TypeIdentifier>, in some JSON responses different types of o
         "createdAt": "2021-07-23T09:36:38Z",
         "url": "https://a.url.com/to/a/video.mp4",
         "duration": 460,
-        "thumbnail": "https://a.url.com/to/a/thmbnail.png"
+        "thumbnail": "https://a.url.com/to/a/thumbnail.png"
       }
     ]
   },

Sources/DynamicCodableKit/DynamicCodableKit.docc/Guides/ContextProvider.md

@@ -4,7 +4,7 @@ Decode dynamic JSON objects based on previous responses or actions by providing
 
 ## Overview
 
-In certain scenarios, the data type present in JSON response will be dependant on previous JSON reponses or a specific action performed. For example, in a social media post detail response, the data present will be indicated by the post type the detail is for, i.e. text based post, picture, audio or video post:
+In certain scenarios, the data type present in JSON response will be dependant on previous JSON responses or a specific action performed. For example, in a social media post detail response, the data present will be indicated by the post type the detail is for, i.e. text based post, picture, audio or video post:
 ```json
 {
   "id": "00005678-abcd-efab-0123-456789abcdef",
@@ -49,7 +49,7 @@ In certain scenarios, the data type present in JSON response will be dependant o
   "createdAt": "2021-07-23T09:36:38Z",
   "url": "https://a.url.com/to/a/video.mp4",
   "duration": 460,
-  "thumbnail": "https://a.url.com/to/a/thmbnail.png",
+  "thumbnail": "https://a.url.com/to/a/thumbnail.png",
   "subTitles": "https://a.url.com/to/a/subTitles.srt",
   "aspectRatio": {
     "hight": 9,
@@ -58,7 +58,7 @@ In certain scenarios, the data type present in JSON response will be dependant o
 }
 ```
 
-To decode post detail JSON dynamically, type repesenting every post type: `TextPostDetail`, `PicturePostDetail`, `AudioPostDetail`, `VideoPostDetail` can be created, each confirming to ``DynamicDecodable`` and to protocol `PostDetail` which represents common post detail type.
+To decode post detail JSON dynamically, type representing every post type: `TextPostDetail`, `PicturePostDetail`, `AudioPostDetail`, `VideoPostDetail` can be created, each confirming to ``DynamicDecodable`` and to protocol `PostDetail` which represents common post detail type.
 ![Decoded models hierarchy.](context-provider-class)
 
 A ``DynamicDecodingContextProvider`` can be created to provide dynamic decoding context. For the current example, a type confirming ``UserInfoDynamicDecodingContextProvider`` can be created that provides the decoding context present in `Decoder`'s `userInfo` property associated to ``UserInfoDynamicDecodingContextProvider/infoKey``.

Sources/DynamicCodableKit/DynamicCodableKit.docc/Guides/TypeIdentifier.md

@@ -42,7 +42,7 @@ It is quite common in JSON responses to have objects that have some common field
       "createdAt": "2021-07-23T09:36:38Z",
       "url": "https://a.url.com/to/a/video.mp4",
       "duration": 460,
-      "thumbnail": "https://a.url.com/to/a/thmbnail.png"
+      "thumbnail": "https://a.url.com/to/a/thumbnail.png"
     }
   ],
   "next": "https://a.url.com/to/next/page"
@@ -59,7 +59,7 @@ Decoding dynamically can be handled by creating types representing every post ty
 
 ### Implement Dynamic Decoding Contexts
 
-Now `Post` type can be dynamically decoded to its concrete type based on value of `PostType` identiifier. `PostType` can be created as an `Enum` confirming to ``DynamicDecodingContextIdentifierKey`` while implementing the decoding context to use with ``DynamicDecodingContextIdentifierKey/associatedContext``. To allow `Decoder` to decode `PostType` and get dynamic decoding context, additional `CodingKey` type `PostCodingKey` need to be defined confirming to ``DynamicDecodingContextCodingKey``. Since current example only has one itentifier to decode confirming to ``DynamicDecodingContextIdentifierCodingKey`` and providing key that contains the identifier in ``DynamicDecodingContextIdentifierCodingKey/identifierCodingKey`` will suffice.
+Now `Post` type can be dynamically decoded to its concrete type based on value of `PostType` identifier. `PostType` can be created as an `Enum` confirming to ``DynamicDecodingContextIdentifierKey`` while implementing the decoding context to use with ``DynamicDecodingContextIdentifierKey/associatedContext``. To allow `Decoder` to decode `PostType` and get dynamic decoding context, additional `CodingKey` type `PostCodingKey` need to be defined confirming to ``DynamicDecodingContextCodingKey``. Since current example only has one identifier to decode confirming to ``DynamicDecodingContextIdentifierCodingKey`` and providing key that contains the identifier in ``DynamicDecodingContextIdentifierCodingKey/identifierCodingKey`` will suffice.
 ```swift
 enum PostCodingKey: String, DynamicDecodingContextIdentifierCodingKey {
     typealias Identifier = PostType

Tests/DynamicCodableKitTests/DynamicDecodingContextCodingKey/Data/IdentifierCollectionDecode.swift

@@ -36,7 +36,7 @@ let identifierCollectionDecode =
           "createdAt": "2021-07-23T09:36:38Z",
           "url": "https://a.url.com/to/a/video.mp4",
           "duration": 460,
-          "thumbnail": "https://a.url.com/to/a/thmbnail.png"
+          "thumbnail": "https://a.url.com/to/a/thumbnail.png"
         }
       ],
       "next": "https://a.url.com/to/next/page"