Add automatic formatter plugin (#11)

* Add formatter plugin with styling options in style.xml

* Re-format src files according to formatter plugin rules

* Add git hooks directory with pre commit hooks

* Fix typo in hook comment

* Refactor githook to run from any directory

* Update array formatting to place contents on new lines

* Add section on formatting and hooks

Author: benjaminkostiuk

.hooks/pre-commit

@@ -0,0 +1,27 @@
+#!/bin/bash
+#
+# A hook script to verify what is about to be committed.
+# Called by "git commit" with no arguments.  The hook should
+# exit with non-zero status after issuing an appropriate message if
+# it wants to stop the commit.
+#
+# To enable this hook, add this file to .git/hooks
+
+set -e
+
+# Get the root of the project
+BASE_DIR="$(git rev-parse --show-toplevel)"
+
+# Run formatter to format files before commit
+mvn -f "$BASE_DIR/pom.xml" formatter:format &>/dev/null
+
+# Find all files staged for commit
+filesStagedForCommit="$(git diff --name-only --cached)"
+
+# Add all files back in case any were changed by formatter
+for file in $filesStagedForCommit
+do
+    git add $file
+done
+
+exit 0

README.md

@@ -83,6 +83,14 @@ Password:
 
 For more information about H2 databases see the [H2 Database Engine](https://www.h2database.com/html/main.html).
 
+### Formatting
+
+The codebase is auto-formatted with the [formatter-maven-plugin](https://code.revelc.net/formatter-maven-plugin/) that will format all source code files in the `src/` and `test/` directories according to the settings in the `style.xml` file, which are based on eclipse profile settings.
+
+Run the `formatter:format` command to run the formatter. It is also bound to the `format` goal that will run as part of the `compile` phase. 
+
+You can also add the git hook in `.hooks` to your local `.git/hooks` folder to run the formatter on pre-commit.
+
 ## Contributors
 The _Puff_ project is looking for contributors to join the initiative!
 For information about progress, features under construction and opportunities to contribute see [our project board](https://github.com/benjaminkostiuk/unity-test/projects/1).

pom.xml

@@ -161,6 +161,22 @@
 					<trimStackTrace>false</trimStackTrace>
 				</configuration>
 			</plugin>
+			<plugin>
+				<groupId>net.revelc.code.formatter</groupId>
+				<artifactId>formatter-maven-plugin</artifactId>
+				<version>2.15.0</version>
+				<configuration>
+					<configFile>${project.basedir}/style.xml</configFile>
+					<encoding>UTF-8</encoding>
+				</configuration>
+				<executions>
+					<execution>
+						<goals>
+							<goal>format</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
 		</plugins>
 		<resources>
 			<resource>