fix: do not HTML escape JSON output by default #765
Merged
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR changes the default JSON encoding behavior by disabling HTML escaping.
- Introduces a JSON encoder that disables HTML escaping by default
- Maintains backward compatibility by allowing users to re-enable escaping via configuration
Comments suppressed due to low confidence (1)
defaults.go:19
- Consider adding unit tests to verify that HTML escaping is correctly disabled in the DefaultJSONFormat.Marshal function. Ensuring this behavior with tests will help prevent regressions in the future.
enc.SetEscapeHTML(false)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #765 +/- ##
=======================================
Coverage 93.05% 93.05%
=======================================
Files 23 23
Lines 5252 5254 +2
=======================================
+ Hits 4887 4889 +2
Misses 313 313
Partials 52 52 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Be default, JSON output is escaped to better support embedding it into HTML. This is extremely unlikely to be needed for HTTP APIs as they have different access patterns. This changes the default behavior to not escape, while letting people who do need the feature set it up in their
huma.Config.Formatsmap as needed.For example,
expected number \u003e= 10becomesexpected number >= 10after this change.