HTML Java JavaScript
Clone or download

README.md

formatter-maven-plugin

Linux Build Status Windows Build status Coverage Status Maven Central Issues Forks Stars Apache License

This project provides a mechanism to automatically (re)format your Maven project during a Maven build, or to verify its formatting, so that your project can converge on consistent code style regardless of user preferences, IDE settings, etc.

It began following a post on the topic (which can be found here; thanks to John for writing such a helpful article). It now uses the Eclipse code formatter for Java, and has grown to support formatting of other file types as well.

For a companion m2e project configurator, see formatter-m2e-configurator.

This software is provided WITHOUT ANY WARRANTY, and is available under the Apache License, Version 2. Any code loss caused by using this plugin is not the responsibility of the author(s). Be sure to use some source repository management system such as GIT before using this plugin.

Contributions are welcome.

How to use

View the Maven plugin documentation for the latest release here.

Eclipse Compatibility


Plugin Version Eclipse Version
0.1.0 3.3.0
0.2.0 - 0.3.1 3.5.2
0.4 3.8.1
0.5.2 4.4.1
1.0.0 3.8.3 (velo fork)
1.1.0 3.8.3 (velo fork)
1.2.0 3.8.3 (velo fork)
1.3.0 3.8.3 (velo fork)
1.4.0 4.4.0 (velo fork - luna)
1.6.0.RC1 4.5.0.RC1 (velo fork - mars)
1.6.0.RC2 4.5.0.RC2 (velo fork - mars)
1.6.0.RC3 4.5.0.RC3 (velo fork - mars)
1.6.0.RC4 4.5.0.RC4 (velo fork - mars)
2.0.0 - 2.0.1 4.5.2 (merged forks - mars)
2.1.0 - 2.6.0 4.6.3 (neon)
2.7.* 4.7.* (oxygen)