[HBASE-26617] Use spotless to reduce the pain on fixing checkstyle issues

• Type: New Feature
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.5.0, 3.0.0-alpha-3, 2.4.13
• Component/s: build, community
• Hadoop Flags: Reviewed

Release Note

Use spotless to format our java file and pom file, using the hbase_eclipse_formatter.xml and eclipse.importerorder file under our dev-support directory.
On all branches, the ratchetFrom is set the commit just before the commit which introduces the spotless plugin, so we will only format the files which are touched in later commits.
From now on, you should type mvn spotless:apply before generating a PR, the spotless plugin will fix most of the format issues for you.

• Assignee: Duo Zhang
• Reporter: Duo Zhang
• Created: 23/Dec/21 00:18
• Updated: 02/Jun/22 12:33
• Resolved: 01/May/22 15:11

Description

https://github.com/diffplug/spotless

Spotless is a tool for reformatting code based on your configuration file, it supports the google java format, as well as a eclipse formatter file.

I think we could use it to format our code, based on a configuration file in our repo, and all the developpers, no matter what IDE they use, they can just type a mvn spotless:apply before commiting a PR, then everything is fine.

Issue Links

• relates to: HBASE-26899 Run spotless:apply
• relates to: HBASE-27083 Run spotless:apply in release scripts when we want to commit something
• relates to: HBASE-26892 Add spotless:check in our pre commit general check
• relates to: HBASE-26915 Miscellaneous improvements before landing spotless reformat
• links to: GitHub Pull Request #4214

Sub-Tasks

• Run spotless:apply: Resolved