org.openrewrite.maven.BestPractices

Author: Vincent Potucek

pmd.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+<ruleset name="DefinitionOfDone"
+         xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.net/ruleset_2_0_0.xsd">
+    <description>DefinitionOfDone</description>
+    <exclude-pattern>.*/Multisets.java</exclude-pattern><!--https://github.com/pmd/pmd/issues/6028-->
+    <exclude-pattern>.*/com/google/common/reflect/A*.*</exclude-pattern>
+    <rule ref="category/java/bestpractices.xml/UnusedPrivateMethod"/>
+    <!--<rule ref="category/java/errorprone.xml/OverrideBothEqualsAndHashCodeOnComparable" />-->
+    <!--<rule ref="category/java/codestyle.xml/UnnecessaryImport" /> https://github.com/pmd/pmd/issues/6027 -->
+    <!--<rule ref="category/java/bestpractices.xml/ModifierOrder"/> https://github.com/pmd/pmd/issues/6019 -->
+</ruleset>

pom.xml

@@ -130,9 +130,69 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-pmd-plugin</artifactId>
+      </plugin>
+      <plugin>
+        <groupId>org.openrewrite.maven</groupId>
+        <artifactId>rewrite-maven-plugin</artifactId>
+      </plugin>
     </plugins>
     <pluginManagement>
       <plugins>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-pmd-plugin</artifactId>
+          <version>3.27.0</version>
+          <configuration>
+            <analysisCache>true</analysisCache>
+            <failOnViolation>true</failOnViolation>
+            <includeTests>true</includeTests>
+            <printFailingErrors>true</printFailingErrors>
+            <rulesets>
+              <ruleset>pmd.xml</ruleset>
+            </rulesets>
+          </configuration>
+          <executions>
+            <execution>
+              <phase>verify</phase>
+              <goals>
+                <goal>check</goal>
+              </goals>
+            </execution>
+          </executions>
+        </plugin>
+        <plugin>
+          <groupId>org.openrewrite.maven</groupId>
+          <artifactId>rewrite-maven-plugin</artifactId>
+          <version>6.15.0</version>
+          <configuration>
+            <activeRecipes>
+              <recipe>DefinitionOfDone</recipe>
+            </activeRecipes>
+            <exclusions>
+              <exclusion>package-info.java</exclusion>
+            </exclusions>
+            <exportDatatables>true</exportDatatables>
+            <failOnDryRunResults>true</failOnDryRunResults>
+          </configuration>
+          <executions>
+            <execution>
+              <phase>verify</phase>
+              <goals>
+                <goal>dryRun</goal>
+              </goals>
+            </execution>
+          </executions>
+          <dependencies>
+            <dependency>
+              <groupId>org.openrewrite.recipe</groupId>
+              <artifactId>rewrite-static-analysis</artifactId>
+              <version>2.16.0</version>
+            </dependency>
+          </dependencies>
+        </plugin>
         <plugin>
           <artifactId>maven-antrun-plugin</artifactId>
           <version>1.6</version>

rewrite.yml

@@ -0,0 +1,6 @@
+type: specs.openrewrite.org/v1beta/recipe
+name: DefinitionOfDone
+displayName: Definition of Done
+description: Automatically cleanup code to comply checkstyle convention.
+recipeList:
+  - org.openrewrite.maven.BestPractices