Add source formatting validation

tolbertam · tolbertam · commit 2238d92b6eb3 · 2016-08-22T14:00:11.000-05:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -24,8 +24,35 @@ in-depth knowledge of the codebase.
 
 ## Editor configuration
 
-We use IntelliJ IDEA with the default formatting options, with one exception: check
-"Enable formatter markers in comments" in Preferences > Editor > Code Style.
+We use Eclipse formatting conventions with a few exceptions:
+
+* Spaces instead of Tabs with 4 space indentation
+* No joining of wrapped lines (for leniency)
+* Disable auto-line wrapping (for leniency)
+* Disable formatting of comments (for leniency)
+* No spaces inserted before and after braces in array initializer
+* Indent statements within switch body
+* Add new lines after each enum constant
+
+A formatting configuration is provided in [src/formatter/java.xml](src/formatter/java.xml)
+that can be importted into both Eclipse and IntelliJ.
+
+Additionally, you may opt to use the formatting-maven-plugin to do the formatting for you
+by executing:
+
+```
+mvn formatter:format
+```
+
+In the module that you wish to do formatting for.  This is required because the formatting
+plugin doesn''t currently recurse child modules.
+
+Source format validation is done as part of the maven build and may be validated
+individually by executing:
+
+```
+mvn formatter:validate
+```
 
 Please format your code and organize imports before submitting your changes.
 
diff --git a/pom.xml b/pom.xml
@@ -338,6 +338,31 @@
                     </execution>
                 </executions>
             </plugin>
+            <!--
+            To update source formatting run:
+            mvn formatter:format
+            -->
+            <plugin>
+                <groupId>com.marvinformatics.formatter</groupId>
+                <artifactId>formatter-maven-plugin</artifactId>
+                <version>1.4.0</version>
+                <configuration>
+                    <configFile>${main.basedir}/src/formatter/java.xml</configFile>
+                    <configJsFile>${main.basedir}/src/formatter/java.xml</configJsFile>
+                    <lineEnding>LF</lineEnding> <!-- linux style line endings -->
+                    <compilerCompliance>${java.version}</compilerCompliance> 
+                    <compilerTargetPlatform>${java.version}</compilerTargetPlatform>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>check-format</id>
+                        <phase>initialize</phase>
+                        <goals>
+                            <goal>validate</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>animal-sniffer-maven-plugin</artifactId>
diff --git a/src/formatter/java.xml b/src/formatter/java.xml
