fix(json): do not HTML-escape <, > and & in JSON output - #556
Open
Sanjays2402 wants to merge 1 commit into
Open
Conversation
json.Marshal escapes <, > and & as \u003c, \u003e and \u0026 so that the result is safe to embed directly in HTML. dasel writes to files and stdout, where that escaping only makes the output harder to read: piping a pyproject.toml through 'dasel -i toml -o json' turned "setuptools>=77.0.3" into "setuptools\u003e=77.0.3". The writer's encoder now uses json.NewEncoder with SetEscapeHTML(false), trimming the newline Encode appends. Adds TestJsonDoesNotEscapeHTMLCharacters, which round-trips a string containing <, > and & and fails on the previous behaviour. Closes TomWright#552
Owner
|
Thank you for the contribution! Could we add a flag here to allow users to toggle this functionality? I'm happy with it skipping HTML encoding by default, but it would be good to keep it available for those that need it. An example of a format specific flat is here: Lines 20 to 28 in 70fd28f Something along the lines of |
This file contains hidden or 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
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.
Closes #552
json.Marshalescapes<,>and&as\u003c,\u003eand\u0026so the result is safe to embed directly in HTML. dasel writes to files and stdout, so that escaping only makes the output harder to read —dasel -i toml -o jsonturned"setuptools>=77.0.3"into"setuptools\u003e=77.0.3".The writer's encoder now uses
json.NewEncoderwithSetEscapeHTML(false)(trimming the newlineEncodeappends).TestJsonDoesNotEscapeHTMLCharactersround-trips a string containing<,>and&; it fails on the previous behaviour and passes with the fix.go test ./...is green, and a CHANGELOG entry is included.This change was prepared with AI assistance; the regression test was run locally and fails without the fix.