Use %q to quote struct tag values #83
Merged
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
bmoylan
commented
Nov 11, 2021
| // Output: | ||
| // type foo struct { | ||
| // A string `json:"a"` | ||
| // B int `bar:"the value of\nthe \"bar\" tag" json:"b"` |
There was a problem hiding this comment.
Previously, we would get B int "bar:\"the value of\nthe\"bar\" tag\" json:\"b\""
Notice that the quotes around bar are escaped at the same level as the quotes for the tag value, meaning the reflect.StructTag.Get parser will recognize the first quote after opening as the end of the value.
|
Looks good to me. |
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.
Previously, it was possible to generate invalid struct tags because not all special characters inside the value are correctly quoted/escaped. Using
%qdelegates to strconv.Quote and ensures we have a valid go string.