Allowing comments in JSON parsed by C# tools

Development Pipeline & Plugins
, ,
1

The generic JSON parsing done by Unreal C# tools does not allow comments.

Our use case is that we use comment-based markup to tag divergences made by game teams in centrally managed or third party code. Currently we are unable to put those kinds of comments for divergences in `.uplugin` files.

I have a PR open for a change to allow comments to be used in such JSON files: https://github.com/EpicGames/UnrealEngine/pull/13608

2

Hi Sean,

Thanks for sharing the PR. Can you provide an example of a uplugin with the comments that won’t pass right now? That would help the developer that will evaluate the PR and increase the chances of it being accepted.

Martin

3

For sure. Here’s an example change we might make to a plugin that would require comments: https://github.com/ssutherland\-riot/Hermes/commit/b1c9027f8ad3785065afe2b0c5f3be78849da4d6

We bundle a set of 3rd party plugins as a default set to all of our game teams, but don’t want any of them enabled by default. So when we ingest them into our source control, we diverge them in this way. The tags allow us to track the divergence, which assists us with merging when we take updates.

4

Thanks for the precisions. I have updated the internal request so the developer that reviews the PR can easily validate the proposed changes.