Add workflow for monitoring the formatting

.github/workflows/JuliaFormatterCI.yml

@@ -0,0 +1,30 @@
+name: JuliaFormatter test
+
+on:
+  push:
+    branches:
+      - master
+      - 'release-*'
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  # group by workflow and ref; the last slightly strange component ensures that for pull
+  # requests, we limit to 1 concurrent job, but for the master branch we don't
+  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.ref != 'refs/heads/master' || github.run_number }}
+  # Cancel intermediate builds, but only if it is a pull request build.
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+jobs:
+  check-consistent-formatting:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: julia-actions/setup-julia@v2
+    - uses: julia-actions/cache@v1
+    - name: 'Check format with JuliaFormatter'
+      run: |
+        julia etc/test_formatting.jl
+      shell: bash
+      env:
+        jf-version: ${{ inputs.version }}

etc/test_formatting.jl

@@ -0,0 +1,104 @@
+using Pkg
+Pkg.activate(temp=true)
+Pkg.add("Test")
+Pkg.add("JuliaFormatter")
+using Test
+using JuliaFormatter
+
+# Disclaimer:
+# The goal should be to work with 
+# https://github.com/julia-actions/julia-format
+# . However, currently too many files have broken formatting and since there
+# are many ongoing pull requests, we will need to extend proper formatting to
+# the entire codebase in a step by step fashion.
+
+
+file = @__FILE__
+oscardir = replace(file, "etc/test_formatting.jl"=>"")
+
+result = 0
+
+@testset "Formatting" begin
+
+  function _gather_source_files(path::String)
+    queue = [path]
+    result = String[]
+    while length(queue) > 0
+      current_folder = pop!(queue)
+      next_batch = readdir(current_folder; join=true)
+      for elem in next_batch
+        if isfile(elem) && endswith(elem, ".jl")
+          push!(result, elem)
+        elseif isdir(elem)
+          push!(queue, elem)
+        end
+      end
+    end
+    return result
+  end
+
+  # Since right now only very few files are formatted, we also use a whitelist
+  # approach.
+  enabled = [
+             "src/PolyhedralGeometry",
+             "src/aliases.jl",
+             "experimental/LieAlgebras",
+             "experimental/BasisLieHighestWeight",
+            ]
+  skip = [
+          "src/PolyhedralGeometry/Polyhedron/standard_constructions.jl",
+          "src/PolyhedralGeometry/Polyhedron/properties.jl",
+          "experimental/LieAlgebras/test/AbstractLieAlgebra-test.jl",
+          "experimental/LieAlgebras/test/LieAlgebraModule-test.jl",
+          "experimental/LieAlgebras/src/LieAlgebra.jl",
+          "experimental/LieAlgebras/src/LieAlgebraHom.jl",
+          "experimental/LieAlgebras/src/LieSubalgebra.jl",
+          "experimental/LieAlgebras/src/LinearLieAlgebra.jl",
+          "experimental/LieAlgebras/src/RootSystem.jl",
+          "experimental/LieAlgebras/src/Util.jl",
+          "experimental/BasisLieHighestWeight/src/MainAlgorithm.jl",
+         ]
+
+  # Collect all code files.
+  entire = [
+            _gather_source_files(joinpath(oscardir, "src/")); 
+            _gather_source_files(joinpath(oscardir, "experimental/"))
+           ]
+
+  failed = String[]
+
+  for file in entire
+    is_enabled = !isnothing(findfirst(e->occursin(e, file), enabled))
+    should_skip = !isnothing(findfirst(e->occursin(e, file), skip))
+    if is_enabled && !should_skip
+      # Do not actually format file, only check whether format is ok.
+      res = @test format(file; overwrite=false)
+      if res isa Test.Fail
+        result = 1
+        filename = replace(file, oscardir=>"")
+        push!(failed, filename)
+      else
+        filename = replace(file, oscardir=>"")
+      end
+    else
+      @test format(file; overwrite=false) skip=true
+    end
+  end
+
+  # Produce some nice output at the end so users do not have to scroll through
+  # entire output.
+  if length(failed) > 0
+    println("""
+The files
+$failed
+were not properly formatted. You can fix the formatting by running
+```
+using JuliaFormatter""")
+    for fn in failed
+      println("format(\"$fn\")")
+    end
+    println("```\n")
+  end
+end
+
+exit(result)