feat!: preserve line breaks between consecutive comments in pretty mode#7770
Merged
Conversation
When multiple comments were attached to the same expression (e.g., from consecutive -- comment lines before a SELECT), they were joined with spaces even in pretty mode. Now they are joined with the generator's separator (newline in pretty mode, space otherwise). Additionally, _replace_line_breaks is applied per-comment content rather than post-join, so newlines between separate comments get proper SQL indentation while newlines within a single multi-line comment remain as sentinels to prevent extra indentation. Closes #7764
Contributor
SQLGlot Integration Test Results✅ All tests passedComparing:
Overallmain: 192428 total, 153523 passed (pass rate: 79.8%) sqlglot:fix/comments-pretty-mode-newlines: 190119 total, 151503 passed (pass rate: 79.7%) Transitions: Dialect pair changes: 0 previous results not found, 1 current results not found ✅ All tests passed |
Leading/separated comments still join with self.sep() (newlines in pretty mode), which is safe since they all precede the same token. Trailing comments must stay space-joined to avoid detaching later comments onto the next node when re-parsed. Co-authored-by: George Sittas <georgesittas@gmail.com>
georgesittas
approved these changes
Jun 20, 2026
Contributor
|
Thank you! |
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
3 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.
When multiple comments are attached to the same expression (e.g., from consecutive
--comment lines before aSELECT), they were joined with spaces even in pretty mode. Now they are joined with the generator's separator (newline in pretty mode, space otherwise).Additionally,
_replace_line_breaksis applied per-comment content rather than post-join, so newlines between separate comments get proper SQL indentation while newlines within a single multi-line comment remain as sentinels to prevent extra indentation.Closes #7764