Format: Add automatic formatter

[benjaminkostiuk]

Overview

Adds an automatic formatter that uses the same formatting rules based on eclipse to format source code files. Closes #14. Very similar to https://github.com/puffproject/course-management/pull/11.

This change is a

• [ ] Bug fix
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that will change exisiting functionality)
• [x] Documentation update

Description

• Add a new plugin to automatically format code by running the mvn formatter:format command. Also bound to the format goal of the compile lifecycle phase. (Will run when you package or run tests)
• Add new .hooks directory with pre-commit hook to allow for automatic code formatting before commiting. Helps ensure that validation status checks don't fail when trying to make a PR.
• Update Readme with hooks instructions + instructions for formatting the code.

Motivation/Links

This will ensure that developers with different styles don't have different styles in the codebases. It also makes the git diffs a little easier to track and read.

How was this tested?

Multiple iterations of testing formatting style changes. No actual code or functionality differences. We can always update the style if there are creative differences.

Todos

• [x] Ensure unit tests pass
• [x] Update documentation for changes (if necessary)
• [ ] Delete stale branch after merge

[benjaminkostiuk]

@OZoneGuy Don't bother looking through all the files, it's litteraly almost every file in the project (mostly identation + minor edits). The main things I want you to be aware of are the updates the README, how to run the formatter and the git hook (up to you). We can talk if there's rules in the style that you don't like 😄.