Was ist der empfohlene Speicherort für benutzerdefinierte Regelwerke für PMD/checkstyle/findbugs?

Question

Wenn Sie Maven mit den verschiedenen Plugins für PMD, Checkstyle und/oder Findbugs verwenden, wie wäre der empfohlene Speicherort für Ihre benutzerdefinierte Regelsatzdatei?

Answer 1

Ich lege sie normalerweise in einem separaten Eltern-Pom, auf diese Weise kann ich sie später in anderen Modulen oder Projekten wiederverwenden. Ähnlich wie auf der Checkstyle-Seite (https://maven.apache.org/plugins/maven-checkstyle-plugin/examples/multi-module-config.html), aber ich halte es aus dem Hauptprojekt heraus.

Sie legen die Dateien mit einem Modul mit dem Namen build-tools, in dem Sie src/main/resources/Ihr/Paket mit Checkstyle und PMD-config und dann gegeben Plugin konfigurieren:

<plugin> 
    <groupId>org.apache.maven.plugins</groupId> 
    <artifactId>maven-checkstyle-plugin</artifactId> 
    <version>2.17</version> 
    <dependencies> 
     <dependency> 
     <groupId>com.example.whizbang</groupId> 
     <artifactId>build-tools</artifactId> 
     <version>1.0</version> 
     </dependency> 
    </dependencies> 
    </plugin> 

FindBugs komplizierter ist, ich normalerweise lassen Sie es wie es ist, und manchmal nur verwenden @SuppressFBWarnings von:

<dependency> 
     <groupId>com.google.code.findbugs</groupId> 
     <artifactId>annotations</artifactId> 
     <version>3.0.1</version> 
    </dependency>