Make UseSingleQuote compliant with the YAML spec #647
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
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #647 +/- ##
==========================================
+ Coverage 77.29% 77.55% +0.25%
==========================================
Files 22 22
Lines 7888 7841 -47
==========================================
- Hits 6097 6081 -16
+ Misses 1372 1347 -25
+ Partials 419 413 -6 |
goccy
reviewed
Feb 11, 2025
encode_test.go
Outdated
| // In the YAML spec, the only escape sequence is '', which represents a single quote. | ||
| // \\, \n, \t, or whatever you might expect YAML, Go strings, and Go strconv.Quote() to escape using the extra backslash, | ||
| // are not escaped and printed as-is in the YAML single-quoted string. | ||
| "a: '\\.yaml'" + "\n", |
There was a problem hiding this comment.
I think this is easier to understand.
`a: \.yaml` + "\n"
Also, since this behavior is self-explanatory, I felt that a comment was unnecessary. The current behavior seems to be an obvious bug in the UseSingleQuote option.
|
Thank you for your great PR ! I've commented. |
|
Thank you for your contribution !! LGTM 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Fixes #643
This follows-up on #265 to fix how single-quoted strings are encoded.
That is, the only escape-sequence in a single-quoted string is now
''which represents'literally.Previously, it treated whatever starting with
\as a escape sequence, which is incorrect in a single-quoted string.That resulted in encoding
\.as\\.for example, which broke my use-case.It's not YAML-compliant anyway so I believe making go-yaml compliant fixes my use-case too.
Before submitting your PR, please confirm the following.
enmcoded_test.go