feat(edit): Remove flexible indentation handling in smart edit
Summary
This PR removes the flexible indentation handling in smart edit to prevent double indentation issues where both the new_string's own indentation and the old_string's indentation are applied together, resulting in doubled indentation. Using single indentation is sufficient for proper formatting.
Details
The previous implementation of flexible indentation handling in the smart edit feature was causing issues with doubled indentation. When performing replacements, both the indentation from the original code (old_string) and the indentation already present in the new_string were being applied, resulting in twice the intended indentation.
This change simplifies the replacement logic by removing the complex indentation handling code and relying on the caller to provide properly formatted new_string values with appropriate indentation. This approach is more predictable and avoids the double indentation problem.
The modification affects the calculateFlexibleReplacement function in smart-edit.ts, which previously attempted to preserve indentation by extracting it from matching lines and applying it to replacement lines. This logic has been simplified to directly use the replacement lines as provided.
Related Issues
How to Validate
Pre-Merge Checklist
- [ ] Updated relevant documentation and README (if needed)
- [x] Added/updated tests (if needed)
- [x] Noted breaking changes (if any)
- [x] Validated on required platforms/methods:
- [ ] MacOS
- [ ] npm run
- [ ] npx
- [ ] Docker
- [ ] Podman
- [ ] Seatbelt
- [ ] Windows
- [ ] npm run
- [ ] npx
- [ ] Docker
- [x] Linux
- [x] npm run
- [x] npx
- [ ] Docker
- [ ] MacOS
Summary of Changes
Hello @adlternative, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request refactors the smart edit feature to simplify its indentation handling. By removing the automatic application of indentation from the old_string to the new_string, it resolves a bug causing double indentation. The system now relies on the caller to provide correctly indented replacement strings, leading to more predictable and accurate code modifications.
Highlights
- Removed Flexible Indentation Handling: The logic for automatically applying indentation based on the
old_stringin thecalculateFlexibleReplacementfunction has been removed. Thenew_stringis now expected to be provided with its correct indentation. - Fixed Double Indentation Issues: This change directly addresses and prevents issues where the smart edit feature would apply double indentation, combining the indentation of the original code with the indentation already present in the replacement string.
- Updated Test Cases: Existing test cases in
smart-edit.test.tshave been updated to reflect the new behavior, and a new test case was added to explicitly verify that thenew_string's own indentation is respected.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.
@silviojr @mrcabbage972 Could you help me review this code?
thanks for your contribution!
I'll assign this to me so I can run tests