Skip to content

[Enhancement] Only Send Updates When Formatting Changed #1188

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 7 commits into from
Oct 15, 2025
Merged

[Enhancement] Only Send Updates When Formatting Changed #1188

merged 7 commits into from
Oct 15, 2025

Conversation

bmarcaur
Copy link
Member

@bmarcaur bmarcaur commented Jan 9, 2025

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

@bmarcaur bmarcaur requested review from CRogers and crogoz January 9, 2025 21:04
@bmarcaur bmarcaur changed the title follow the API guidelines and only update when formatted file is changed [WIP] Only Send Updates When Formatting Changed Jan 9, 2025
@bmarcaur bmarcaur force-pushed the bmarcaurele/only-send-format-when-changed branch from ae2a2c2 to 8f96dc6 Compare February 27, 2025 21:57
@bmarcaur bmarcaur changed the title [WIP] Only Send Updates When Formatting Changed [Enhancement] Only Send Updates When Formatting Changed Feb 27, 2025
@bmarcaur bmarcaur marked this pull request as ready for review February 27, 2025 21:58
bmarcaur
bmarcaur commented Mar 6, 2025
View reviewed changes
...ugin/src/main/java/com/palantir/javaformat/intellij/PalantirJavaFormatFormattingService.java Outdated
// 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()) {
Copy link
Member Author

@bmarcaur bmarcaur Mar 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Damn so it would turn out that even when the file is fully formatted it still produces a replacement which looks like:

image

A full file replacement with the same content... Seems like a bug in the formatter service.

CC @crogoz @carterkozak :(

Copy link
Member Author

Choose a reason for hiding this comment

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

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 bmarcaur force-pushed the bmarcaurele/only-send-format-when-changed branch from 27dfe25 to 70d44a5 Compare March 6, 2025 18:45
@bmarcaur bmarcaur force-pushed the bmarcaurele/only-send-format-when-changed branch from 70d44a5 to b2fb695 Compare March 6, 2025 18:52
@bmarcaur bmarcaur requested a review from crogoz October 15, 2025 15:14
@changelog-app
Copy link

changelog-app bot commented Oct 15, 2025 •
edited by bmarcaur
Loading

Generate changelog in changelog/@unreleased

Type (Select exactly one)

  • Feature (Adding new functionality)
  • Improvement (Improving existing functionality)
  • Fix (Fixing an issue with existing functionality)
  • Break (Creating a new major version by breaking public APIs)
  • Deprecation (Removing functionality in a non-breaking way)
  • Migration (Automatically moving data/functionality to a new system)

Description

[Enhancement] Only Send Updates When Formatting Changed

Check the box to generate changelog(s)

  • Generate changelog entry

@changelog-app
Copy link

changelog-app bot commented Oct 15, 2025

✅ Successfully generated changelog entry!

What happened?

Your changelog entries have been stored in the database as part of our migration to ChangelogV3.

Need to regenerate?

Simply interact with the changelog bot comment again to regenerate these entries.

📋Changelog Preview

💡 Improvements

  • [Enhancement] Only Send Updates When Formatting Changed (#1188)

@bulldozer-bot bulldozer-bot bot merged commit 67bec58 into develop Oct 15, 2025
7 checks passed
@bulldozer-bot bulldozer-bot bot deleted the bmarcaurele/only-send-format-when-changed branch October 15, 2025 15:23
@autorelease3
Copy link

autorelease3 bot commented Oct 15, 2025

Released 2.80.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@crogoz crogoz crogoz approved these changes

@CRogers CRogers Awaiting requested review from CRogers

+1 more reviewer

@carterkozak carterkozak carterkozak left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

autorelease merge when ready

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@bmarcaur @carterkozak @crogoz