Skip to content

Fix adding element to multiline array after inline array in yaml #1665

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pincher2012 wants to merge 2 commits into
base: 1.x
Choose a base branch
from
+34 −1
Open

Fix adding element to multiline array after inline array in yaml #1665

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a0d7f1
Failed test for yaml update bug
Feb 25, 2025
9d68798
Attempt to fix the bug
pincher2012 Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/Util/YamlSourceManipulator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,7 +544,15 @@ private function advanceBeyondMultilineArrayLastItem(): void
}

$nextLineBreak = $this->findNextLineBreak($this->currentPosition);
if ('}' === trim(substr($this->contents, $this->currentPosition, $nextLineBreak - $this->currentPosition))) {
if (false === $nextLineBreak) {
$this->log('The last line, going to EOL');
$this->advanceToEndOfLine();

return;
}

$lastSymbolBeforeLineBreak = trim(substr($this->contents, $this->currentPosition, $nextLineBreak - $this->currentPosition));
if (\in_array($lastSymbolBeforeLineBreak, ['}', ']'], true)) {
$this->log('The line ends with an array closing brace, going to EOL');
$this->advanceToEndOfLine();
}
Expand Down
12 changes: 12 additions & 0 deletions tests/Util/yaml_fixtures/add_item_to_array_after_array.test
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
framework:
messenger:
routing:
App\Messages\OldMessage: [ transport1, transport2 ]
===
$data['framework']['messenger']['routing']['App\Messages\NewMessage'] = 'async';
===
framework:
messenger:
routing:
App\Messages\OldMessage: [ transport1, transport2 ]
App\Messages\NewMessage: async
Copy link
Member

@GromNaN GromNaN Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand the missing newline at EOF is related to the issue.

What do you think of making YamlSourceManipulator always ensure there is an empty newline at EOF? That is our style rules.

Suggested change
App\Messages\NewMessage: async
App\Messages\NewMessage: async

Copy link
Author

@pincher2012 pincher2012 Feb 4, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review!

Personally, I prefer to leave a new line at the end of the file.

I think this bundle could be used in codebases that might not adhere to the generally accepted style in symfony. Should we impose any formatting rules on the user?

13 changes: 13 additions & 0 deletions tests/Util/yaml_fixtures/add_item_to_array_after_array_trailing_newline.test
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
framework:
messenger:
routing:
App\Messages\OldMessage: [ transport1, transport2 ]

===
$data['framework']['messenger']['routing']['App\Messages\NewMessage'] = 'async';
===
framework:
messenger:
routing:
App\Messages\OldMessage: [ transport1, transport2 ]
App\Messages\NewMessage: async
Loading