Generate CodingKeys enum in @Entity macro - #39
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
@Entitynow generates apublic enum CodingKeys: String, CodingKey, Sendable, CaseIterablewith a case foridplus every@Attribute/@CompositeAttribute/@Relationshipproperty, in declaration order.CodingKeysenum (or typealias), the macro skips generation and the manual declaration is used.Stringraw type keeps the generated enum compatible with Embedded Swift, whereCodingKeysynthesis without a raw type is unavailable.Limitation
When entity A's
@Relationship(inverse: .foo)references entity B's keys, the compiler must type-check.fooagainstB.CodingKeyswhile macros are still expanding, and it will not expand@Entity's generated enum to satisfy another macro's argument. Entities referenced as a relationship destination therefore still need a manualCodingKeys; this is documented in the test model.Testing
CodingKeyssuppresses generation.Facilityin the test model now relies on the generated enum, confirmingCodablesynthesis picks it up.