Add CodingKeyRepresentable support for dictionary keys instead of LosslessStringConvertible#216
Open
sindresorhus wants to merge 2 commits intomainfrom
Open
Add CodingKeyRepresentable support for dictionary keys instead of LosslessStringConvertible#216sindresorhus wants to merge 2 commits intomainfrom
CodingKeyRepresentable support for dictionary keys instead of LosslessStringConvertible#216sindresorhus wants to merge 2 commits intomainfrom
Conversation
…LosslessStringConvertible` Fixes #99
648878a to
d37c2ea
Compare
hank121314
approved these changes
Oct 3, 2025
Collaborator
hank121314
left a comment
There was a problem hiding this comment.
Many thanks for this 🙇!
Really LGTM!
Just a question and one nit 🙏
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.
Fixes #99
I don't expect to merge this anytime soon because of the system requirements and it being a breaking change, but I would like a review.
Why CodingKeyRepresentable instead of LosslessStringConvertible?
CodingKeyRepresentable is the better choice because:
Designed for dictionary keys: CodingKeyRepresentable was specifically created to enable
non-String/Int types as Codable dictionary keys. It's purpose-built for this exact use case.
Better enum support: Enums with Int raw values get automatic CodingKeyRepresentable conformance from the standard library.
Cannot support both: Swift explicitly forbids multiple conditional conformances of Dictionary to Serializable, even with different conditional bounds. We must choose one approach.
What works as dictionary keys?
Types that are only LosslessStringConvertible (like Bool) won't work. However, these are uncommon as dictionary keys and using them often indicates a design issue.