pkg/yaml: correct alias keys #247
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
As outlined in #247, the yaml library did not initially handle this edge case of using an alias node as a key properly. This PR adds functionality to correct that. In case there is some other edge case where this breaks, the `disable_alias_key_correction` formatter config option was added.
octo
added a commit
to octo/yamlfmt
that referenced
this pull request
Jun 23, 2025
PR google#247 introduced a regression with YAML documents such as this: ```yaml config: &shared key: value instance: <<: *shared ``` Due to the "correct alias keys" setting, a extra space was emitted after `*shared`. This created trailing whitespace which many tools (rightly) complain about. This change adds an extra condition to only emit the space in the "simple key" context. I'm not enough of a YAML expert to be sure this is the right thing to do, but it fixes my problem without failing any of the existing tests.
braydonk
pushed a commit
that referenced
this pull request
Jun 23, 2025
* fix(yaml): Remove trailing whitespace from merge aliases. PR #247 introduced a regression with YAML documents such as this: ```yaml config: &shared key: value instance: <<: *shared ``` Due to the "correct alias keys" setting, a extra space was emitted after `*shared`. This created trailing whitespace which many tools (rightly) complain about. This change adds an extra condition to only emit the space in the "simple key" context. I'm not enough of a YAML expert to be sure this is the right thing to do, but it fixes my problem without failing any of the existing tests. * test(formattest): Print a diff between the expected and actual result.
steeef
pushed a commit
to steeef/yamlfmt
that referenced
this pull request
Sep 5, 2025
* pkg/yaml: correct alias keys As outlined in google#247, the yaml library did not initially handle this edge case of using an alias node as a key properly. This PR adds functionality to correct that. In case there is some other edge case where this breaks, the `disable_alias_key_correction` formatter config option was added. * forgot to fix this comment * forgot to enable the setting for this test
steeef
pushed a commit
to steeef/yamlfmt
that referenced
this pull request
Sep 5, 2025
* fix(yaml): Remove trailing whitespace from merge aliases. PR google#247 introduced a regression with YAML documents such as this: ```yaml config: &shared key: value instance: <<: *shared ``` Due to the "correct alias keys" setting, a extra space was emitted after `*shared`. This created trailing whitespace which many tools (rightly) complain about. This change adds an extra condition to only emit the space in the "simple key" context. I'm not enough of a YAML expert to be sure this is the right thing to do, but it fixes my problem without failing any of the existing tests. * test(formattest): Print a diff between the expected and actual result.
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.
As outlined in #242, the yaml library did not initially handle this edge case of using an alias node as a key properly. This PR adds functionality to correct that. In case there is some other edge case where this breaks, the
disable_alias_key_correctionformatter config option was added.