Automated Java code formatting and verification #2694
Merged
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
Define a common format for all georchestra modules using an eclipse formatter definition file, which will be passed as an argument to the net.revelc.code.formatter:formatter-maven-plugin. The format follows standard Java formatting conventions with 120 characters line wrap limit and 4 spaces for indentation.
Add the net.revelc.code.formatter:formatter-maven-plugin maven plugin to the root pom's pluginManagement section and configure it with to be inherited by child projects that add it to their <plugins> section. The plugin is configured to format only java source code files using the .mvn/formatter.xml eclipse formatter definition. This formatter can be directly imported from eclipse IDE and from IntelliJ IDEA's "Eclipse Code Formatter" plugin (https://plugins.jetbrains.com/plugin/6546-eclipse-code-formatter). When compiling a project that includes the formatter-maven-plugin, the default action is to format the source code to adhere to the defined code style. The other option is to instruct the plugin to check for correct formatting and fail the build. This behavior is controlled by the fmt.action property, like in: mvn compile -Dfmt.action=format or -Dfmt.action=validate. On a CI build server (Jenkins/Travis-CI), the -Dfmt.action=validate should be used, to ensure a committer did his/her due diligence before pushing to the upstream git repository. Finally, the plugin can be disabled with the -Dfmt.skip=true maven property.
Add the formatter-maven-plugin to the build/plugins section on the following projects: analytics, atlas, commons, console, extractorapp, header, mapfishapp, ogc-server-statistics, security-proxy. The plugin configuration is inherited from the root pom.
Tell Travis-ci to validate the code formatting during the install phase, and to ignore the formatter-maven-plugin during the script phase. This ensures the build fails if ill-formatted code was committed at an early stage, and avoids double running for the plugin.
This is the first commit after configuring the formatter-maven-plugin, with formatting applied. From this point on, all commits pushed to github must have well formatted content, or the build will fail on travis-ci. There's nothing special to do though, other than having compiled/built the project before committing. The maven plugin will re-format the code when building, before the compile phase.
This was referenced Aug 23, 2019
|
Not a big fan of big PRs reformatting code, as it often invalidates/creates useless conflicts with all pending PRs. Oh well.. has to be done someday, i guess. |
RemiDesgrange
approved these changes
Aug 26, 2019
I think it will be better to keep the reformatting with no changes in a separate commit (for history and understanding purposes). |
|
Thanks Gabriel, awesome. |
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.
Apply formatter-maven-plugin formatting to all projects.
Add the
net.revelc.code.formatter:formatter-maven-pluginand configure it to be inherited by georchestra projects (no geoserver/geonetwork submodules).The plugin is configured to format only java source code files using the
.mvn/formatter.xmleclipse format definition.This file can be directly imported from eclipse IDE and from IntelliJ IDEA's Eclipse Code Formatter plugin.
When compiling a project that includes the formatter-maven-plugin, the default action is to format the source code to adhere to the defined code style.
The other option is to instruct the plugin to check for correct formatting and fail the build.
This behavior is controlled by the fmt.action property, like in
mvn compile -Dfmt.action=formator-Dfmt.action=validate. By default a project build will run theformataction, so nothing special needs to be done in order to ensure the proper format of the code other than making sure to run the build before committing/pushing to github.On a CI build server (Jenkins/Travis-CI), the
-Dfmt.action=validateshould be used, to ensure a committer did his/her due diligence before pushing to the upstream git repository, which is already the case for Travis-CI.Finally, the plugin can be disabled with the
-Dfmt.skip=truemaven property.