Checkstyle

Checkstyle einrichten

Für die Programmierfächer aus Semester 1 und 2 wurde Checkstyle eingeführt mit mehr Einschränkungen als es die Java Sun Konvention vorsieht (Zeilenlänge, Npath Complexity und co).

Steps

• Bei der Aufgabenerstellung muss der Haken bei "statische Codeanalyse" gesetzt werden. Späteres Hinzufügen von Checkstyle ist umständlich!

• Weitere Eingaben tätigen und Test Repository clonen.
• Geclontes Repo enthält 3 statische Codeanalyse Tools. Alle Konfigurationsdateien befinden sich unter staticCodeAnalysisConfig.

• Inhalt der Checkstyle Konfiguration austauschen mit unserer Konfiguration. Checkstyle Konfiguration findet sich unten unter Anhänge.
• BeforeExecutionExclusionFileFilter in der Konfiguration anpassen. Das enthaltene Regex filtert alle Dateien heraus, die nicht den genannten String enthalten. Das hat den Vorteil, wenn den Studierenden mehrere fertige Dateien zur Verfügung gestellt werden, diese nicht von Checkstyle geprüft werden. Dementsprechend werden im Regex nur Dateien gelistet, die von Studirenden bearbeitet werden. Nachteil ist, dass neue erstellte Dateien ggf auch nicht getestet werden. Falls das Filtern nicht erwünscht ist, das gesamte Modul auskommentieren!

Entfernen von Spotbugs und PMD oder Checkstyle

Beim Erstellen von Aufgaben mit statischer Code Analyse erstellt Artemis ein Projekt mit Checkstyle, Apache PMD und Spotbugs. Wenn eines der Tools nicht benötigt wird, muss die Dependency im Projekt gelöscht werden und das Build Script angepasst werden.

Unter Build-Plane bearbeiten finden sich die mvn commands, um die genannten Tools auszuführen.

Die Methode staticCodeAnalysis alle Commands. Beim Entfernen von z.B. PMD muss nicht nur der Command pmd:pmd pmd:cpd entfernt werden, sondern auch die copy Commands für die Reports.

Mögliche Seiteneffekte