fix: preserve YAML string quotes in frontmatter#43
Open
brettdavies wants to merge 1 commit intobutler54:mainfrom
Open
fix: preserve YAML string quotes in frontmatter#43brettdavies wants to merge 1 commit intobutler54:mainfrom
brettdavies wants to merge 1 commit intobutler54:mainfrom
Conversation
Set `preserve_quotes=True` on the ruamel.yaml YAML instance so that quoted strings in frontmatter are preserved during round-trip formatting. Without this, ruamel.yaml strips "unnecessary" quotes, producing unwanted diffs and potentially breaking tooling that relies on quoted strings. Fixes butler54#42
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
1 participant
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.
Summary
Set
preserve_quotes=Trueon the ruamel.yaml YAML instance so that quoted strings in frontmatter are preserved during round-trip formatting.Problem
Without this, ruamel.yaml strips "unnecessary" quotes from YAML string values:
Fix
One-line change in
plugin.py:yaml = ruamel.yaml.YAML() +yaml.preserve_quotes = TrueWith
preserve_quotes=True, ruamel.yaml loads strings into special subclasses (DoubleQuotedScalarString,SingleQuotedScalarString) that preserve their original quote style when dumped back. This is the standard ruamel.yaml approach for lossless round-tripping.Fixes #42