Maven IDE hook

[lipiridi]

Duplicate the IDE hook that is implemented for the Gradle plugin - #568
The main issue pertains to supporting Maven in an IntelliJ plugin - #200 (comment)

Currently, I utilize the spotlessFiles argument for Maven-based projects in my IntelliJ plugin to execute the apply task only for the currently opened file in the editor. However, an IDE hook that accepts an absolute path is safer (as it's not a pattern) and a little more efficient.

I have also updated the example of spotlessFiles usage in the README, as it cannot accept slashes in the pattern. Instead, it is necessary to provide the regex dot .

[nedtwigg]

Thanks! In Gradle, the spotlessIdeHook provides output using stdout, stderr, and stdin, like so

• IDE hook #568 (comment)

Do you plan to implement that here too? Or is only disk I/O enough for your case? If disk I/O is enough then we should be able to use spotlessFiles without adding spotlessIdeHook...

[lipiridi]

I think I have just understood why it was implemented via stdout in the Gradle plugin.

Retrieving the edited file from the stdout is much faster because we don't access the I/O file. Moreover, the file will be saved in the file system by the IDE, not directly by Spotless. Am I correct?

If yes, then I'll try to replicate this feature in Maven and label the PR as a work in progress.

Thanks)

[nedtwigg]

If yes, then I'll try to replicate this feature in Maven and label the PR as a work in progress.

That would be great!

Retrieving the edited file from the stdout is much faster because we don't access the I/O file. Moreover, the file will be saved in the file system by the IDE, not directly by Spotless. Am I correct?

It's not about speed, it's about letting the user work without saving and clobbering changes on disk that perhaps they didn't want to save over.

• user opens a file
• user changes the file within the editor
• user asks to format this contents of the editor
• Spotless returns the formatted contents of that editor to the editor

The point of the IDE hook is to facilitate that process without saving to disk in between the various steps. Saving to disk is fine for an IDE plugin, but you can use spotlessFiles for that, you don't need spotlessIdeHook.

[lipiridi]

Hi @nedtwigg!
I've updated the PR and added the same IDE hook. Here's what's new:

1. I removed the check ratchet.isClean() from the hook because the Maven plugin already collects only dirty files from Git.
2. Unfortunately, I couldn't replicate the "diverge" test. I'm not sure how to do it via Maven. Any guidance on this would be appreciated.
3. I reverted the README. Perhaps it's worth considering combining the IDE_HOOK.md for both plugins, but I'll leave that decision up to you.

[nedtwigg]

Finally released in plugin-maben 2.40.0. Terribly sorry that it took so long, this is a great PR for an important feature, so I wanted to do some testing before we released it. I just don't have much time at the moment for Spotless, so I released it with the "beta" warning in the changelog.

Once there is an IDE plugin working with the maven hook let me know, and we can update the docs to match and remove the beta.