Remove length marker option#14
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR removes the lengthMarker encoder option to align with the TOON v3 specification, which no longer includes this feature. This is a breaking change that simplifies the encoder API by removing an optional feature that prefixed array lengths with a # character in the output format.
Key changes:
- Removed the
lengthMarkerproperty andLengthMarkerenum fromTOONEncoder - Updated all
formatHeaderfunction calls to remove thelengthMarkerparameter - Removed encoder tests specific to the length marker feature
- Removed documentation section explaining length marker usage
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| Sources/ToonFormat/Encoder.swift | Removed LengthMarker enum, lengthMarker property, and updated all formatHeader calls to exclude the length marker parameter |
| Tests/ToonFormatTests/EncoderTests.swift | Removed 6 test functions that tested the length marker feature with various configurations |
| Tests/ToonFormatTests/DecoderTests.swift | Removed round-trip test for length marker encoding/decoding |
| README.md | Removed documentation section explaining the length marker feature with code examples |
💡 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
Closes #13
Description
This PR removes the length marker option, which was removed from the v3 spec.
Type of Change
Changes Made
lengthMarkerproperty and nestedLengthMarkertype inTOONEncoderSPEC Compliance
Testing
Pre-submission Checklist
Breaking Changes
We will release a new minor / pre-1.0 version.
Additional Context