Disallow dup json comments #40390
Merged
Disallow dup json comments #40390
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
Previously we whitelisted "//" and "comment" as keys which were allowed to be duplicated in json objects. Stop doing that. Allowing these duplicate keys only causes problems when attempting to process the game data files using other json tools or libraries.
jbytheway
requested review from
I-am-Erk,
John-Candlebury and
KorGgenT
as code owners
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.
Summary
SUMMARY: Infrastructure "Stop allowing duplicate comment keys in json"
Purpose of change
Our json parser allowed
"//"and"comment"as special cases which could appear as duplicate keys in json objects. This caused issues when people try to script alterations to the json using other json libraries, etc.Describe the solution
Stop allowing that.
Update the cases that exist to not do that any more.
I only updated the core data and mods that aren't on the test blacklist. It's hard to fix the others. I'm hoping they have few errors and, if they exist, I'm sure we'll get issue reports about them soon.
Describe alternatives you've considered
Hacking around the problem in ancillary scripting somehow.
Testing
Unit tests (including the mods, where possible).
Additional context
To assist me with scripting a solution to #40321.