Better / Consistent Formatting

[baldawar]

What is your idea?

Add some means to have consistent formatting across the codebase. See comment https://github.com/aws/event-ruler/pull/39/files#r967886681 for some early thoughts.

Would you be willing to make the change?

Maybe

[baldawar]

I looked into this a bit more while reviewing #60. Seems there's a bunch of options listed within https://github.com/google/google-java-format. Love the idea of a github actions so that we don't have to talk about formatting during reviews.

There's also https://github.com/revelc/formatter-maven-plugin.

All of these are tools I'm not too familiar with, so more deep dive is required on if there's any gotchas or regressions that such tools can introduce.

[schenksj]

Might not be a terrible idea to add husky (https://github.com/typicode/husky) hooks into the repo to assure that code has been formatted, along with a 1-time reformat PR for the selected formatter. Only real downside is that husky will required you to install node/npm on any machine used for development.

My teams at my day job have had great success with enforcing this in python with black, pylint, and pycov (and for golang go test -cover, go fmt, and golangci-lint). I believe similar open source tools exist for java as well. Personally, I've had great luck with google-java-format just using the default configuration. It is wonderful how (whether you like how the resulting code looks or not), there is a single correct answer to things that "sort-of" matter.