add SpellCheck CI

[andrewwinters5000]

We have used this spell checker to help catch typos in the docs and code comments in other parts of the trixi-framework and it has been quite helpful.

[DavidAKopriva]

Interesting and looks useful. It doesn't know fortran, however.

[andrewwinters5000]

Interesting and looks useful. It doesn't know fortran, however.

It seems to be "smart" enough to work directly for the most part. I added an extra word "INOUT" to its dictionary such that it does not think this fortran keyword is something that is misspelled.

[andrewwinters5000]

Also kudos @DavidAKopriva ! With the amount of docs and comments in this code the auto-spellchecker only found about 35 typos which is quite nice.

[codecov[bot]]

Codecov Report

Merging #63 (15a4e6a) into main (3113cb3) will not change coverage. The diff coverage is 71.98%.

@@           Coverage Diff           @@
##             main      #63   +/-   ##
=======================================
  Coverage   74.31%   74.31%           
=======================================
  Files          68       68           
  Lines       10259    10259           
=======================================
  Hits         7624     7624           
  Misses       2635     2635           

Flag	Coverage Δ
unittests	74.31% <71.98%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
Source/HOHQMeshMain.f90	44.61% <0.00%> (ø)
Source/IO/FileAndStringProcessing.f90	38.09% <0.00%> (ø)
Source/Mesh/LaplaceMeshSmoother.f90	0.00% <0.00%> (ø)
Source/Surfaces/SMTopographyClass.f90	65.21% <ø> (ø)
Source/Project/MeshProject.f90	76.12% <50.00%> (ø)
Source/Mesh/MeshBoundaryMethods.f90	79.89% <60.00%> (ø)
...ce/Curves/DiscreteCurves/FRSegmentedCurveClass.f90	72.77% <60.60%> (ø)
Source/Testing/TestDataClass.f90	68.42% <62.50%> (ø)
...Curves/ContinuousCurves/EquationEvaluatorClass.f90	82.68% <63.36%> (ø)
Source/3DSource/SimpleSweep.f90	90.32% <65.51%> (ø)
... and 15 more

[andrewwinters5000]

I didn't check all files since there is a huge amount of whitespace changes.

Thanks, I only realized too late that my VSCode was removing all the whitespace making this PR look much larger than it is.

You could also consider adding the new CI run to the required CI checks for PRs etc.

I thought I did with the on: [pull_request] part of the new yml file. Do I need to modify the ci.yml too?

[ranocha]

You could also consider adding the new CI run to the required CI checks for PRs etc.

I thought I did with the on: [pull_request] part of the new yml file. Do I need to modify the ci.yml too?

This let's it run for every PR. If you want to make it a required check, you need to go to the settings of this repo, then branches, edit the rules for main, and add the spell check Ci run to the required checks. I can also do that if you like.

[andrewwinters5000]

You could also consider adding the new CI run to the required CI checks for PRs etc.

I thought I did with the on: [pull_request] part of the new yml file. Do I need to modify the ci.yml too?

This let's it run for every PR. If you want to make it a required check, you need to go to the settings of this repo, then branches, edit the rules for main, and add the spell check Ci run to the required checks. I can also do that if you like.

No that's okay, I can do it here (and also for HOHQMesh.jl).

[ranocha]

If you do it here, you can also consider adding more Ci checks to the required ones, e.g., CI / linux - gfortran-12 - regular