BREAKING(jsonc): remove allowTrailingComma option
#5119
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5119 +/- ##
=======================================
Coverage 92.72% 92.73%
=======================================
Files 479 479
Lines 38305 38294 -11
Branches 5394 5390 -4
=======================================
- Hits 35520 35513 -7
+ Misses 2732 2728 -4
Partials 53 53 ☔ View full report in Codecov by Sentry. |
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.
What's changed
This change removes the
ParseOptions.allowTrailingCommaoption, and therefore theParseOptionsinterface. For now on, trailing commas are allowed (the previous default) without the ability to change.Why this change was made
This change was made because setting
ParseOptions.allowTrailingCommatofalseseemed to lack any useful use case. Also, having this added control also added some logic overhead. By removing this option, we slightly simplify the API surface of@std/jsoncwhile still remaining compatible with the majority of existing use cases.Migration guide
No further action is needed for users that didn't use the
optionsargument ofparse()or setoptions.allowTrailingCommatotrue.For users that set
options.allowTrailingCommatofalse,parse()now no longer throws aSyntaxErrorwhen it encounters a trailing comma.