Automate code formatting using Maven #2494
Closed
Conversation
This file contains 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
Still Eclipse based, should accept the same config file format. Docs: https://code.revelc.net/formatter-maven-plugin/ Source: https://github.com/revelc/formatter-maven-plugin
|
@walles Would you be able to craft a separate PR with 2019 formatter? This would help us to do at least a visual comparison. Thanks either ways! |
|
Thank you very much @walles |
|
I think having one of these PRs open should be enough. Closing in favour of #2495. |
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 change
CONTRIBUTING.mdencouraged reformatting sources usingmake format.make formatwould reformat lots of files, not just the ones you changed.With this change in place
Any
mvnoperation will implicitly format sources.CI will validate code formatting.
This implicitly means that people have to at least
mvn compiletheir sources locally before making PRs to make sure they don't get refused by CI.This enforces good practice, regardless of the actual formatting.
Notes
Files to be reviewed (the rest have been auto formatted):
pom.xmlMakefile.github/CONTRIBUTING.mdAlso, checking the commits list might be easier than looking at files changed, all reformatting is confined to the last change.
The code formatting Maven plugin being used didn't have any
validategoal so I replaced with another one.Still running the Eclipse formatter though, so
hbase-formatter.xmlstill works.hbase-formatter.xmlis from 2014. It could potentially be replaced with a newer one from 2019, I haven't done that though.