Automatically Format Java Source Code

[vorburger]

The Java Source Code in this project is not consistently formatted.

Would a PR to add e.g. https://github.com/google/google-java-format based formatting be welcome?

There would be a one time bulk reformat, and then the Maven build would automagically re-format it.

[manandbytes]

Would a PR to add e.g. https://github.com/google/google-java-format based formatting be welcome?

According to https://github.com/google/google-java-format#third-party-integrations, this would be (assuming Ant build would go away) via Spotless Maven plugin, https://github.com/diffplug/spotless/tree/main/plugin-maven#google-java-format ?

[cstamas]

I want to tackle this next. My fave is spotless as well...

Steps needed:

• agree on formatting and details (I'd format both: source and POM)
• add spotless w/ config we agreed on to POM
• reformat (no other code change)
• once reformat commit has git hash, add git blame immediately afterwards

Example may be Maven Resolver:

• updated parent POM (where spotless plugin was set and configured): apache/maven-resolver@97dfd1c
• immediately followed by apache/maven-resolver@2c6e289

In short, 2nd commit needs git hash of first commit.

[cstamas]

@ianopolous ping

[cstamas]

Example setup from ASF Maven Parent (uses palantir but is similar):
https://github.com/apache/maven-parent/blob/master/pom.xml#L1217 and below

Key points:

• use dynamically goal https://github.com/apache/maven-parent/blob/master/pom.xml#L1261
• on developer workstation formating always happens (one should not even think about it), on CI only formatting enforcement happens https://github.com/apache/maven-parent/blob/master/pom.xml#L1408-L1429

[ianopolous]

Sounds good!

[vorburger]

@cstamas I personally prefer Spotless with the Google Java Formatter over using it with Palantir's fork of it, but that's just me.

[cstamas]

Yes, I just said spotless (so there are 3 aligned here), and I just show ASF Maven parent (that uses palantir, was not my proposal). Google format it is. Any other wishes? Can be POM formatted same as on ASF projects?