{"id":20655904,"url":"https://github.com/it-at-m/itm-java-codeformat","last_synced_at":"2025-08-14T08:34:28.430Z","repository":{"id":161490652,"uuid":"635788666","full_name":"it-at-m/itm-java-codeformat","owner":"it-at-m","description":"it@M Java code formatter rules","archived":false,"fork":false,"pushed_at":"2025-07-16T09:36:50.000Z","size":282,"stargazers_count":1,"open_issues_count":4,"forks_count":2,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-07-17T13:11:40.830Z","etag":null,"topics":["formatter","java","spotless"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/it-at-m.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-05-03T13:07:23.000Z","updated_at":"2025-07-16T09:36:53.000Z","dependencies_parsed_at":null,"dependency_job_id":"8395144e-a7cf-446b-a601-6e66bb6b5932","html_url":"https://github.com/it-at-m/itm-java-codeformat","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/it-at-m/itm-java-codeformat","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/it-at-m%2Fitm-java-codeformat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/it-at-m%2Fitm-java-codeformat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/it-at-m%2Fitm-java-codeformat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/it-at-m%2Fitm-java-codeformat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/it-at-m","download_url":"https://codeload.github.com/it-at-m/itm-java-codeformat/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/it-at-m%2Fitm-java-codeformat/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270387161,"owners_count":24574958,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-14T02:00:10.309Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["formatter","java","spotless"],"created_at":"2024-11-16T18:13:02.348Z","updated_at":"2025-08-14T08:34:28.413Z","avatar_url":"https://github.com/it-at-m.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# itm-java-codeformat\n\nBietet 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.\n\n## Verwendung\n\n### IDE\n\n[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.\n\nDie gängigen Java IDE's unterstützen den Import von Eclipse XML Profilen.\n\n#### Eclipse\n\nIn den Einstellungen (`Window` - `Preferences`) im Reiter `Java / Codestyle / Formatter` mittels `Import` die Datei importieren und anschließend mit `Apply and Close` übernehmen.\n\n![Screenshot Eclipse Java Formatter Einstellungen](docs/eclipse_formatter.PNG)\n\n#### IntelliJ\n\nIn 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.\n\n![Screenshot IntelliJ Java Formatter Einstellungen](docs/intellij_formatter.png)\n\n#### VS Code\n\nIn VS Code kann direkt auf das XML aus dem Repository in den Workspace Settings verwiesen werden.\n\n`\u003cproject\u003e/.vscode/settings.json`:\n```json\n{\n    \"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\"\n}\n```\n\n### Maven\n\nMaven Plugin `spotless-maven-plugin` hinzufügen:\n\n```xml\n\u003c!-- https://mvnrepository.com/artifact/com.diffplug.spotless/spotless-maven-plugin --\u003e\n\u003cplugin\u003e\n    \u003cgroupId\u003ecom.diffplug.spotless\u003c/groupId\u003e\n    \u003cartifactId\u003espotless-maven-plugin\u003c/artifactId\u003e\n    \u003cversion\u003e2.44.5\u003c/version\u003e\n    \u003cdependencies\u003e\n        \u003cdependency\u003e\n            \u003cgroupId\u003ede.muenchen.oss\u003c/groupId\u003e\n            \u003cartifactId\u003eitm-java-codeformat\u003c/artifactId\u003e\n            \u003cversion\u003e1.0.10\u003c/version\u003e\n        \u003c/dependency\u003e\n    \u003c/dependencies\u003e\n    \u003cconfiguration\u003e\n        \u003cjava\u003e\n            \u003cincludes\u003e\n                \u003cinclude\u003esrc/main/java/**/*.java\u003c/include\u003e\n                \u003cinclude\u003esrc/test/java/**/*.java\u003c/include\u003e\n            \u003c/includes\u003e\n            \u003ceclipse\u003e\n                \u003cfile\u003eitm-java-codeformat/java_codestyle_formatter.xml\u003c/file\u003e\n                \u003c!-- Das hier ist entscheidend, damit es in der LHM Umgebung funktioniert! --\u003e\n                \u003cp2Mirrors\u003e\n                    \u003cp2Mirror\u003e\n                        \u003cprefix\u003ehttps://download.eclipse.org\u003c/prefix\u003e\n                        \u003curl\u003ehttps://${p2.username}:${p2.password}@${p2.mirror}\u003c/url\u003e\n                    \u003c/p2Mirror\u003e\n                \u003c/p2Mirrors\u003e\n            \u003c/eclipse\u003e\n            \u003ctrimTrailingWhitespace/\u003e\n            \u003cendWithNewline/\u003e\n        \u003c/java\u003e\n    \u003c/configuration\u003e\n    \u003cexecutions\u003e\n        \u003cexecution\u003e\n            \u003cgoals\u003e\n                \u003cgoal\u003echeck\u003c/goal\u003e\n            \u003c/goals\u003e\n        \u003c/execution\u003e\n    \u003c/executions\u003e\n\u003c/plugin\u003e\n```\n\nDadurch wird beim Build automatisch der Code auf Einhaltung der Formatierungsregeln überprüft (Goal `check`).\n\nWeitere Einstellungen siehe [offizielle Plugin-Dokumentation](https://github.com/diffplug/spotless/tree/main/plugin-maven).\n\n### Terminal\n\nEine Anwendung der Formatierungsregeln (-\u003e Formattieren) kann manuell über `mvn spotless:apply` durchgeführt werden.\n\nEine Überprüfung der Formatierungsregeln kann ebenso manuell über `mvn spotless:check` durchgeführt werden.\n\n## Contributing\n\nBei Änderungswünschen bzw. Änderungsbedarf bitte ein Issue erstellen.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fit-at-m%2Fitm-java-codeformat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fit-at-m%2Fitm-java-codeformat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fit-at-m%2Fitm-java-codeformat/lists"}