Let json-stream
formatter escape quotes in strings
#59
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.
Description
I found that the
json-stream
formatter currently does not escape any quotation marks in strings so that the output won't be well-formed JSON.For example, this results in invalid JSON being produced:
The result will be
{"foo":"test " "}
.I am fixing this by overriding the
serializeString
method to escape quotes.Motivation and context
I think the issue is self-explanatory.
How has this been tested?
I updated one test to include a quotation mark which caused the test to no longer pass.
I then made the test pass again by supplying an implementation for
serializeString
that escapes quotes.Screenshots (if appropriate)
Types of changes
What types of changes does your code introduce? Put an
x
in all the boxes that apply:Checklist:
Go over all the following points, and put an
x
in all the boxes that apply.Please, please, please, don't send your pull request until all of the boxes are ticked. Once your pull request is created, it will trigger a build on our continuous integration server to make sure your tests and code style pass.
If you're unsure about any of these, don't hesitate to ask. We're here to help!