Skip to content
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

fix: handle empty lines for languages with semantic whitespace #99

Merged
merged 1 commit into from
Mar 28, 2024

Conversation

ilevyor
Copy link
Contributor

@ilevyor ilevyor commented Mar 27, 2024

fixes: #84
lines containing only whitespace will be rewritten as empty lines

Summary by CodeRabbit

  • Refactor
    • Improved modularity and readability of range adjustments in code.
  • Tests
    • Added tests for Python support with empty lines in code snippets.

@ilevyor ilevyor requested a review from a team March 27, 2024 21:02
Copy link
Contributor

coderabbitai bot commented Mar 27, 2024

Walkthrough

The recent update introduces a modular approach to adjusting ranges within the codebase by extracting the adjust_ranges function, enhancing code maintainability and readability. Additionally, it addresses Python language support by adding a test for empty lines, directly tackling issues related to the handling of trailing whitespace in Python code.

Changes

Files Change Summary
.../src/binding.rs Extracted adjust_ranges for modular range adjustment; simplified adjust_padding logic.
.../src/test.rs Added python_support_empty_line test for Python empty line handling.

Assessment against linked issues

Objective Addressed Explanation
Handle removal of trailing whitespace for Python language (#84)

🐇✨
In the realm of code, where logic does play,
A rabbit hopped in, making things okay.
With a leap and a bound, it refined the way,
Adjusting the ranges, in a modular display.
Python's whitespace, no longer astray,
For the rabbit's touch, made it all okay.
🌟🐾

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • Generate unit-tests for this file.
    • 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 generate unit tests for this file.
    • @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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@morgante
Copy link
Contributor

I'm not sure we actually want to do this. The root cause of that issue looked like a problem in Monaco, not anything in GritQL.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 5879b22 and dacc0ea.
Files selected for processing (2)
  • crates/core/src/binding.rs (2 hunks)
  • crates/core/src/test.rs (1 hunks)
Additional comments: 3
crates/core/src/binding.rs (2)
  • 106-115: The adjust_ranges function correctly iterates over substitutions and adjusts the ranges based on the provided index and delta. However, there's a potential risk of integer overflow when casting from isize to usize. Consider adding a safety check to ensure that the resulting value is not negative before casting.
  • 150-152: The handling of empty lines by adjusting ranges with a negative delta is a crucial part of the fix for handling trailing whitespace in languages with semantic whitespace. Consider adding a comment here to explain the rationale behind this approach for future maintainability.
crates/core/src/test.rs (1)
  • 12889-12918: The test function python_support_empty_line is well-structured and appears to correctly simulate the scenario of handling empty lines in Python code snippets. However, for future maintainability, consider adding a comment explaining the purpose of the test and the specific issue it addresses.

@ilevyor
Copy link
Contributor Author

ilevyor commented Mar 27, 2024

I'm not sure we actually want to do this. The root cause of that issue looked like a problem in Monaco, not anything in GritQL.

the code is valid regardless of the whitespace on the empty line, I ran the python. I'm sure people have empty lines in their codebases in the middle of a code block I don't see why we shouldn't support that.

@ilevyor ilevyor changed the title fix: handle emptylines for languages with semantic whitespace fix: handle empty lines for languages with semantic whitespace Mar 27, 2024
@morgante morgante merged commit 854dc69 into main Mar 28, 2024
8 checks passed
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.

Doesn't handle removal of trailing whitespace for python language
2 participants