Add formatting (#16)

Co-authored-by: Uwe Hernandez Acosta <u.hernandez@hzdr.de>

.formatting/Project.toml

@@ -0,0 +1,2 @@
+[deps]
+JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"

.formatting/format_all.jl

@@ -0,0 +1,12 @@
+using JuliaFormatter
+
+# we assume the format_all.jl script is located in QEDevents.jl/.formatting
+project_path = Base.Filesystem.joinpath(Base.Filesystem.dirname(Base.source_path()), "..")
+
+not_formatted = format(project_path; verbose=true)
+if not_formatted
+    @info "Formatting verified."
+else
+    @warn "Formatting verification failed: Some files are not properly formatted!"
+end
+exit(not_formatted ? 0 : 1)

.github/workflows/formatter.yaml

@@ -0,0 +1,17 @@
+name: formatter
+on: [pull_request]
+jobs:
+  formatter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout repo
+        uses: actions/checkout@v4
+      - name: install Julia
+        uses: julia-actions/setup-julia@v1
+        with:
+          version: 1.9
+      - name: Install Julia requirements
+        run: julia --project=${GITHUB_WORKSPACE}/.formatting -e 'import Pkg; Pkg.instantiate()'
+      - name: Check code style
+        run: julia --project=${GITHUB_WORKSPACE}/.formatting ${GITHUB_WORKSPACE}/.formatting/format_all.jl
+

docs/make.jl

@@ -12,12 +12,7 @@ makedocs(;
         edit_link="main",
         assets=String[],
     ),
-    pages=[
-        "Home" => "index.md",
-    ],
+    pages=["Home" => "index.md"],
 )
 
-deploydocs(;
-    repo="github.com/QEDjl-project/QEDcore.jl",
-    devbranch="main",
-)
+deploydocs(; repo="github.com/QEDjl-project/QEDcore.jl", devbranch="main")