Skip to content

fix: Improve SQL formatter handling of long lines (#1717) #1724

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
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

anandgupta42
Copy link
Contributor

@anandgupta42 anandgupta42 commented Jul 20, 2025

Fixed an issue where the SQL formatter would corrupt SQL files with long lines by incorrectly moving column aliases to different positions.
fix for #1717
Changes:

  • Simplified the diff processing logic to handle changes more directly
  • Removed complex chunk boundary calculations that were causing misalignment
  • Use TextEdit.replace for normal changes instead of delete+insert pattern
  • Added proper bounds checking for all edit operations
  • Removed the intermediate line movement logic between chunks

The formatter now correctly preserves the structure of SQL files with long lines and maintains the association between columns and their aliases.

🤖 Generated with Claude Code

Overview

Problem

Describe the problem you are solving. Mention the ticket/issue if applicable.

Solution

Describe the implemented solution. Add external references if needed.

Screenshot/Demo

A picture is worth a thousand words. Please highlight the changes if applicable.

How to test

  • Steps to be followed to verify the solution or code changes
  • Mention if there is any settings configuration added/changed/deleted

Checklist

  • I have run this code and it appears to resolve the stated issue
  • README.md updated and added information about my change

Important

Fixes SQL formatter corruption issue with long lines by simplifying diff processing and ensuring proper bounds checking in dbtDocumentFormattingEditProvider.ts.

  • Behavior:
    • Fixes SQL formatter corruption issue with long lines by maintaining column-alias association.
    • Uses TextEdit.replace for normal changes instead of delete+insert pattern in processDiffOutput().
    • Removes intermediate line movement logic between chunks in processDiffOutput().
  • Logic:
    • Simplifies diff processing logic in processDiffOutput().
    • Adds bounds checking for all edit operations in processDiffOutput().
    • Removes complex chunk boundary calculations in processDiffOutput().
  • Misc:

This description was created by Ellipsis for 59f2fbb. You can customize this summary. It will automatically update as commits are pushed.

Fixed an issue where the SQL formatter would corrupt SQL files with long lines
by incorrectly moving column aliases to different positions.

Changes:
- Simplified the diff processing logic to handle changes more directly
- Removed complex chunk boundary calculations that were causing misalignment
- Use TextEdit.replace for normal changes instead of delete+insert pattern
- Added proper bounds checking for all edit operations
- Removed the intermediate line movement logic between chunks

The formatter now correctly preserves the structure of SQL files with long
lines and maintains the association between columns and their aliases.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Copy link
Contributor

coderabbitai bot commented Jul 20, 2025

Warning

Rate limit exceeded

@anandgupta42 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 28 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 9b02f74 and 59f2fbb.

📒 Files selected for processing (1)
  • src/document_formatting_edit_provider/dbtDocumentFormattingEditProvider.ts (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

Important

Looks good to me! 👍

Reviewed everything up to 59f2fbb in 1 minute and 38 seconds. Click for details.
  • Reviewed 113 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 3 draft comments. View those below.
  • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. src/document_formatting_edit_provider/dbtDocumentFormattingEditProvider.ts:115
  • Draft comment:
    Consider explicitly handling the insertion-at-end-of-document case instead of relying on a ternary operator within the bounds check. Using an early return or a clear separate branch here would improve readability and reduce nesting.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 20% vs. threshold = 50% The ternary operator here is actually quite clear and concise - it's handling a simple binary choice of where to insert text based on line position. Breaking this into separate branches might actually make the code more verbose without adding clarity. The current structure with bounds checking followed by the insertion logic is reasonably clear. The comment does align with the general principle of preferring explicit control flow. The current nested structure (if followed by ternary) could be seen as slightly harder to follow. While explicit control flow is good, the current code is actually quite readable and the ternary operator is being used appropriately for a simple either/or condition. The suggestion would increase code complexity without clear benefit. The comment should be deleted as the current code structure is sufficiently clear and the suggested change would not significantly improve readability.
2. src/document_formatting_edit_provider/dbtDocumentFormattingEditProvider.ts:108
  • Draft comment:
    Removal of the chunk boundary logic simplifies the implementation. Please verify that diffs with multiple non-contiguous chunks are correctly handled by processing each change individually.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50% The comment is asking the PR author to verify that a specific behavior is correctly handled, which violates the rule against asking for verification or confirmation of behavior. It does not provide a specific suggestion or point out a clear issue with the code.
3. src/document_formatting_edit_provider/dbtDocumentFormattingEditProvider.ts:126
  • Draft comment:
    The bound checks for normal and delete changes use '< document.lineCount' while the add changes allow '<=' for insertion at the document end. Confirm that these conditions are intentional and consistently reflect VS Code's indexing behavior.
  • Reason this comment was not posted:
    Confidence changes required: 50% <= threshold 50% None

Workflow ID: wflow_IKlV7R5Tmwd1BRoS

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant