Add formatter plugin

[oparent.git] / pom.xml

diff --git a/pom.xml b/pom.xml
index 6eaab6f..3d1e047 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -152,6 +152,46 @@
           <artifactId>sonar-maven-plugin</artifactId>
           <version>${sonar.scanner.version}</version>
         </plugin>
+        <!--
+        Using https://code.revelc.net/formatter-maven-plugin/ for Eclipse formatter
+        Using https://github.com/diffplug/spotless/tree/master/plugin-maven for import order
+        Use in combination to rewrite code and imports, then checkstyle
+
+        Be sure to override ${project.parent.basedir} in order to find the XML file
+
+        1st - your project should be inheriting from this oparent java dependency
+        2nd - go into your project's source directory
+        3rd - type in the following and make sure you set the path to where you have oparent cloned and its
+              onap-java-formatter.xml file
+
+        mvn formatter:format spotless:apply process-sources -Dproject.parent.basedir=TODO
+        -->
+        <plugin>
+            <groupId>net.revelc.code.formatter</groupId>
+            <artifactId>formatter-maven-plugin</artifactId>
+            <version>2.11.0</version>
+            <configuration>
+                <configFile>${project.parent.basedir}/onap-java-formatter.xml</configFile>
+            </configuration>
+            <!-- https://code.revelc.net/formatter-maven-plugin/
+                 use mvn formatter:format to rewrite source files
+                 use mvn formatter:validate to validate source files -->
+        </plugin>
+        <plugin>
+            <groupId>com.diffplug.spotless</groupId>
+            <artifactId>spotless-maven-plugin</artifactId>
+            <version>1.26.1</version>
+            <configuration>
+                <java>
+                    <importOrder>
+                        <order>com,java,javax,org</order>
+                    </importOrder>
+                </java>
+            </configuration>
+            <!-- https://github.com/diffplug/spotless/tree/master/plugin-maven
+                 use mvn spotless:apply to rewrite source files
+                 use mvn spotless:check to validate source files -->
+        </plugin>
       </plugins>
     </pluginManagement>
     <plugins>