Format repo and use formatter workflow

[JoshuaLampert]

I ran the JuliaFormatter for the repo with the settings from Meshes.jl, see .JuliaFormatter.toml. This results in a lot of changes of course. Sorry for that. Are you open for automatic code formatting to ensure consistency and readability, @mikeingold? Additionally, I added another GitHub Actions workflow to automatically check the formatting for every PR, see also JuliaGeometry/Meshes.jl#965 for more details.

[codecov]

Codecov Report

Attention: Patch coverage is 88.23529% with 8 lines in your changes missing coverage. Please review.

Project coverage is 90.59%. Comparing base (bdd69e2) to head (75964e4).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
src/utils.jl	40.00%	6 Missing ⚠️
src/integral.jl	92.30%	1 Missing ⚠️
src/specializations/BezierCurve.jl	80.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #86      +/-   ##
==========================================
+ Coverage   90.35%   90.59%   +0.24%     
==========================================
  Files          16       16              
  Lines         311      319       +8     
==========================================
+ Hits          281      289       +8     
  Misses         30       30              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[mikeingold]

I like the idea of using something like JuliaFormatter to ensure consistency with a common code style, but I'll probably need to think more about which particular code style to enforce. As-is, I've landed on a particular style in this repo that is pretty self-consistent but kind of esoteric and could use an update. Personally, I think I prefer SciMLStyle, which seems slightly different from these auto-recommendations.

[JoshuaLampert]

Personally, I also prefer the SciMLStyle. This is also the one I use in my repos. I just used the style from Meshes.jl as a first proposal to get the discussion started. I'll quickly reformat. Then we can see how it looks like.

[JoshuaLampert]

I'm too lazy to resolve all the conflicts. I'll just close this PR, create a new branch, reformat there and create a new PR.