https://github.com/it-at-m/itm-java-codeformat

it@M Java code formatter rules
https://github.com/it-at-m/itm-java-codeformat

formatter java spotless

Last synced: 5 months ago
JSON representation

it@M Java code formatter rules

• Host: GitHub
• URL: https://github.com/it-at-m/itm-java-codeformat
• Owner: it-at-m
• License: mit
• Created: 2023-05-03T13:07:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-07-16T09:36:50.000Z (6 months ago)
• Last Synced: 2025-07-17T13:11:40.830Z (6 months ago)
• Topics: formatter, java, spotless
• Language: Java
• Homepage:
• Size: 275 KB
• Stars: 1
• Watchers: 10
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# itm-java-codeformat

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

## Verwendung

### IDE

[java_codestyle_formatter.xml](formatter/src/main/resources/itm-java-codeformat/java_codestyle_formatter.xml) herunterladen und speichern und anschließend in der IDE importieren.

Die gängigen Java IDE's unterstützen den Import von Eclipse XML Profilen.

#### Eclipse

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

![Screenshot Eclipse Java Formatter Einstellungen](docs/eclipse_formatter.PNG)

#### IntelliJ

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.

![Screenshot IntelliJ Java Formatter Einstellungen](docs/intellij_formatter.png)

#### VS Code

In VS Code kann direkt auf das XML aus dem Repository in den Workspace Settings verwiesen werden.

`/.vscode/settings.json`:

```json

{

    "java.format.settings.url": "https://raw.githubusercontent.com/it-at-m/itm-java-codeformat/main/formatter/src/main/resources/itm-java-codeformat/java_codestyle_formatter.xml"

}

```

### Maven

Maven Plugin `spotless-maven-plugin` hinzufügen:

```xml

    com.diffplug.spotless

    spotless-maven-plugin

    2.44.5

    

        

            de.muenchen.oss

            itm-java-codeformat

            1.0.10

        

    

    

        

            

                src/main/java/**/*.java

                src/test/java/**/*.java

            

            

                itm-java-codeformat/java_codestyle_formatter.xml

                

                

                    

                        https://download.eclipse.org

                        https://${p2.username}:${p2.password}@${p2.mirror}

                    

                

            

            

            

        

    

    

        

            

                check

            

        

    

```

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

Weitere Einstellungen siehe [offizielle Plugin-Dokumentation](https://github.com/diffplug/spotless/tree/main/plugin-maven).

### Terminal

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.

## Contributing

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