Bietet die it@M Codeformatter Regeln für Java als Artefakt an, sodass diese von Spotless automatisiert während des Maven Builds geprüft (mvn spotless:check) bzw. umgesetzt (mvn spotless:apply) werden können.

java_codestyle_formatter.xml herunterladen und speichern und anschließend in der IDE importieren.

Sowohl Eclipse als auch IntelliJ unterstützen den Import von Eclipse XML Profilen.

In den Einstellungen (Window - Preferences) im Reiter Java / Codestyle / Formatter mittels Import die Datei importieren und anschließend mit Apply and Close übernehmen.

In den Einstellungen (File - Settings) im Reiter Editor / Code Style / Java unter den Scheme Actions mittels Import Scheme - Eclipse XML Profile die Datei importieren und anschließend mit Apply übernehmen und Close das Fenster schließen.

Maven Plugin spotless-maven-plugin hinzufügen:

<plugin> <groupId>com.diffplug.spotless</groupId> <artifactId>spotless-maven-plugin</artifactId> <version>2.28.0</version> <dependencies> <dependency> <groupId>de.muenchen.oss</groupId> <artifactId>itm-java-codeformat</artifactId> <version>${itm-codeformat.version}</version> </dependency> </dependencies> <configuration> <java> <includes> <include>src/main/java/**/*.java</include> <!-- Check application code --> <include>src/test/java/**/*.java</include> <!-- Check application tests code --> </includes> <eclipse> <file>itm-java-codeformat/java_codestyle_formatter.xml</file> </eclipse> <trimTrailingWhitespace/> <endWithNewline/> </java> </configuration> <executions> <execution> <goals> <goal>check</goal> </goals> </execution> </executions> </plugin>

Dadurch wird beim Build automatisch der Code auf Einhaltung der Formatierungsregeln überprüft (Goal check).

Weitere Einstellungen siehe offizielle Plugin-Dokumentation.

Eine Anwendung der Formatierungsregeln (-> Formattieren) kann manuell über mvn spotless:apply durchgeführt werden.

Eine Überprüfung der Formatierungsregeln kann ebenso manuell über mvn spotless:check durchgeführt werden.

Bei Änderungswünschen bzw. Änderungsbedarf bitte ein Issue erstellen.