Use Scalafmt for Code Formatting and Consistency

[athersharif]

https://scalameta.org/scalafmt/

some background relevant conversation for context is here.

[misaugstad]

Pasting over the relevant bits from that thread:

@athersharif

thoughts on scalafmt?

@misaugstad

Looks pretty good! Want to create an issue for it? I imagine we would have a PR that updates style across the project. We would then add to the dev environment setup instructions! 😁

@athersharif

yup, 💯 . creating an issue for it, shortly. it will touch a gazillion files so probably should work on it when nothing critical is in a pr state otherwise it'd be a rebasing nightmare. 🤣

[misaugstad]

So in PR #2430 @uditpatwal added linters for JavaScript, CSS, and HTML. We did not include the scalafmt formatter in that PR because we didn't know of a way to enforce only a small subset of rules. We didn't find an easy to way just ignore all rules and then include just the ones we wanted. So there were a ton of rules that we didn't want, and it would have been a lot of work to figure out which ones we needed to ignore.

Would still love to have a Scala linter! I would at least want to add just a few rules or warnings for things where I can't think of obvious exceptions to the rule that we have. Just need to either find a new linter that lets us do that, or figure out how to do that using scalafmt.