don't emit organize-imports code action when result is identical#3177
Open
akhilesharora wants to merge 2 commits intozigtools:masterfrom
Open
don't emit organize-imports code action when result is identical#3177akhilesharora wants to merge 2 commits intozigtools:masterfrom
akhilesharora wants to merge 2 commits intozigtools:masterfrom
Conversation
The source.organizeImports code action always emitted insert + delete edits whose net effect was no change, causing editor undo-stack churn and diagnostic flicker on already-organized files. Apply the generated edits in-memory and suppress the action if the resulting source matches the original. Fixes zigtools#2523
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
1 participant
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 imports are already organized,
source.organizeImportsstill returned insert + delete edits whose net effect is no change. Clients apply them anyway, which dirties the buffer, adds to the undo stack, and flickers virtual text diagnostics. The reporter notes gopls returns no edits in this case.This builds the organize edits, applies them to the source in memory, and skips emitting the code action when the result equals the original text. Happy to switch to a structural check instead if that's preferred. Went with apply and compare because it seemed simpler to reason about.
Added a test with three already organized shapes that asserts no
source.organizeImportsaction is returned; it fails on master and passes here. Also ran the built binary against the exact source from the issue as a sanity check.Fixes #2523