Add YAML StringUtils.quoteIfNeeded() for safe scalar quoting#7416
Merged
Jenson3210 merged 2 commits intomainfrom Apr 17, 2026
Merged
Add YAML StringUtils.quoteIfNeeded() for safe scalar quoting#7416Jenson3210 merged 2 commits intomainfrom
Jenson3210 merged 2 commits intomainfrom
Conversation
Add a utility method that quotes YAML scalar values only when syntactically necessary (indicator characters, colon-space, space-hash, document markers, whitespace, control characters). Uses minimal quoting: single quotes by default, double quotes only when escape sequences are needed.
timtebeek
approved these changes
Apr 17, 2026
This was referenced Apr 18, 2026
Closed
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.
Summary
StringUtils.quoteIfNeeded(String)inorg.openrewrite.yaml.internalthat quotes YAML scalar values only when syntactically necessary:or#, starts with---/..., has leading/trailing whitespace, or contains control characters'or control chars)true,null,123— those are valid YAML as-isMotivation
AddSpringPropertyfails to quote values containing colons. ThequoteValuemethod inrewrite-springuses a regex that only matches strings made entirely of special characters, missing mixed values likeTODO: Follow this link https://example.com/page.With this utility in
rewrite-yaml,rewrite-spring(and other modules) can replace ad-hoc quoting logic with a spec-compliant implementation.Test plan
./gradlew :rewrite-yaml:test --tests "org.openrewrite.yaml.internal.StringUtilsTest"