fix: Fix option parsing and types #258
Merged
Conversation
This file contains 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
Gudahtt
force-pushed
the
fix-option-types
branch
2 times, most recently
from
cadeec5 to
3d02668
Compare
The option types wrongly declared `jsonSortOrder` as a required option, resulting in a type mismatch. If no `jsonSortOrder` was specified, it would be typed as `Record<..>` despite having the value `null`. This had no runtime functional impact but it was still wrong and confusing. The option parsing has been updated to better preserve type safety, and the types have been updated to differentiate pre-processed options, processed options, and options with defaults applied at runtime.
Gudahtt
force-pushed
the
fix-option-types
branch
from
3d02668 to
ce216a3
Compare
Gudahtt
commented
Jan 6, 2025
| if (jsonSortOrder) { | ||
| sortCompareFunction = createSortCompareFunction(jsonSortOrder); | ||
| } | ||
| const sortCompareFunction = createSortCompareFunction(jsonSortOrder); |
There was a problem hiding this comment.
The default option of {} is now applied before this point, so we don't need to consider where jsonSortOrder is unset anymore. {} is equivalent to lexical sort.
This was referenced Jan 6, 2025
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.
The option types wrongly declared
jsonSortOrderas a required option, resulting in a type mismatch. If nojsonSortOrderwas specified, it would be typed asRecord<..>despite having the valuenull. This had no runtime functional impact but it was still wrong and confusing.The option parsing has been updated to better preserve type safety, and the types have been updated to differentiate pre-processed options, processed options, and options with defaults applied at runtime.
This can be omitted from the changelog because the fixed types are not exported.