Encode dictionary keys in deterministic order#25
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR aims to ensure deterministic output when encoding Swift Dictionary values with TOONEncoder, aligning behavior with the linked spec-compliance issue/PR (#22).
Changes:
- Sort encoded dictionary keys lexicographically to make output deterministic.
- Add tests to validate deterministic dictionary ordering and to validate the
DictionaryCodingKey-based detection heuristic. - Document object key ordering behavior in the README.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| Tests/ToonFormatTests/EncoderTests.swift | Adds regression tests for deterministic dictionary ordering and the dictionary-key heuristic. |
| Sources/ToonFormat/Encoder.swift | Implements dictionary detection heuristic and uses sorted keys for dictionary encoding. |
| Sources/ToonFormat/Value.swift | Removes unused Value.from(_:) factory logic. |
| README.md | Documents preserved struct field ordering and lexicographic sorting for dictionary keys. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Linked Issue
Alternative to #22
Description
Type of Change
Changes Made
SPEC Compliance
Testing
Pre-submission Checklist
Breaking Changes
Additional Context