[Enhancement] Only Send Updates When Formatting Changed #1188
Conversation
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
bmarcaur
changed the title
bmarcaur
commented
Jan 9, 2025
...ugin/src/main/java/com/palantir/javaformat/intellij/PalantirJavaFormatFormattingService.java
Outdated
Show resolved
Hide resolved
bmarcaur
force-pushed
the
bmarcaurele/only-send-format-when-changed
branch
from
ae2a2c2 to
8f96dc6
Compare
bmarcaur
changed the title
bmarcaur
commented
Mar 6, 2025
| // The Javadoc of onTextReady API says that you should set it to null when the | ||
| // document is unchanged. But an even better version is to simply not attempt | ||
| // to format a document that is already formatted | ||
| if (replacements.isEmpty()) { |
There was a problem hiding this comment.
Damn so it would turn out that even when the file is fully formatted it still produces a replacement which looks like:
A full file replacement with the same content... Seems like a bug in the formatter service.
CC @crogoz @carterkozak :(
There was a problem hiding this comment.
To avoid having to remote debug your intellij, here is a failing test that exemplifies the issue: https://github.com/palantir/palantir-java-format/pull/1188/files#diff-a6622bd2788dface780176f19bbaecce6308bb0a826e6e6721b0c713bc0e2c68R450
bmarcaur
force-pushed
the
bmarcaurele/only-send-format-when-changed
branch
from
27dfe25 to
70d44a5
Compare
bmarcaur
force-pushed
the
bmarcaurele/only-send-format-when-changed
branch
from
70d44a5 to
b2fb695
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Before this PR
Every format action caused the current buffer to be marked as modified.
After this PR
This was due to us updating the text on every format even if it was unchanged. Now it only updates when something was formatted.
Way more context than you could ever want: https://youtrack.jetbrains.com/issue/IJPL-162382