-
Couldn't load subscription status.
- Fork 45
fix: preserve indentation after comment lines #1969
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.
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
benfdking
wants to merge
1
commit into
main
Choose a base branch
from
codex/fix-formatting-issue-with-sql-comments
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # Comment-Induced Indentation Bug | ||
|
|
||
| A comment placed as the first line inside a parenthesized expression could cause the | ||
| next line to receive an extra level of indentation. For example: | ||
|
|
||
| ```sql | ||
| SELECT | ||
| col1, | ||
| ( | ||
| -- BIG NOTE 1: Adding this comment breaks the indentation of the output. | ||
| file_type ILIKE '%tif%' | ||
| ) AS col2 | ||
| ``` | ||
|
|
||
| Running `sqruff fix` on this query previously produced: | ||
|
|
||
| ```sql | ||
| SELECT | ||
| col1, | ||
| ( | ||
| -- BIG NOTE 1: Adding this comment breaks the indentation of the output. | ||
| file_type ILIKE '%tif%' | ||
| ) AS col2 | ||
| ``` | ||
|
|
||
| The comment-only line after the opening parenthesis was treated as consuming an | ||
| additional indent. The following line then inherited this inflated indent balance, | ||
| shifting the subsequent lines too far to the right. | ||
|
|
||
| ## Fix | ||
|
|
||
| The indentation mapper now resets comment-only lines to the preceding line's | ||
| indentation and clears any untaken indents. As a result, comment lines no longer | ||
| alter the indent level of the code that follows them: | ||
|
|
||
| ```sql | ||
| SELECT | ||
| col1, | ||
| ( | ||
| -- BIG NOTE 1: Adding this comment breaks the indentation of the output. | ||
| file_type ILIKE '%tif%' | ||
| ) AS col2 | ||
| ``` |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Comment Line Bug Causes Indentation Issues
The new logic incorrectly modifies the line immediately following a comment-only line. This can break indentation for subsequent comment lines or normal code, and only updates the first indent point, leading to inconsistent line state. Additionally,
comment_line_idx + 1has a potential integer overflow.