use format-check from MixedModels.jl

Author: getzze

.github/workflows/CI.yml

@@ -17,13 +17,37 @@ env:
 
 
 jobs:
+  format-check:
+    # note: keep in sync with `format/run.jl`
+    name: Style check (Julia ${{ matrix.julia-version }} - ${{ github.event_name }})
+    # Run on push's or non-draft PRs
+    if: (github.event_name == 'push') || (github.event.pull_request.draft == false)
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        julia-version: [1.6]
+    steps:
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{ matrix.julia-version }}
+      - uses: actions/checkout@v4
+      - name: Instantiate `format` environment and format
+        run: |
+          julia --project=format -e 'using Pkg; Pkg.instantiate()'
+          julia --project=format 'format/run.jl'
+      - uses: reviewdog/action-suggester@v1
+        if: github.event_name == 'pull_request'
+        with:
+          tool_name: JuliaFormatter
+          fail_on_error: true
+
   test:
-    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    name: Julia ${{ matrix.julia-version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        version:
+        julia-version:
           - '1.6'
           - '1'  # latest stable 1.x release
           - 'nightly'
@@ -32,10 +56,10 @@ jobs:
         arch:
           - x64
     steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@latest
         with:
-          version: ${{ matrix.version }}
+          version: ${{ matrix.julia-version }}
           arch: ${{ matrix.arch }}
       - uses: actions/cache@v1
         env:
@@ -57,8 +81,8 @@ jobs:
     name: Documentation
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@latest
         with:
           version: '1'
       - name: Install dependencies

.github/workflows/format-check.yml

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

format/Project.toml

@@ -0,0 +1,26 @@
+using JuliaFormatter
+
+function main()
+    perfect = true
+    # note: keep in sync with `.JuliaFormatter.toml`
+    # and with `.github/workflows/CI.yml` format-check
+    for d in ["src/", "test/", "docs/"]
+        @info "...linting $d ..."
+        dir_perfect = format(
+            d;
+            style=BlueStyle(),
+            join_lines_based_on_source=true,
+            remove_extra_newlines = false,
+        )
+        perfect = perfect && dir_perfect
+    end
+    if perfect
+        @info "Linting complete - no files altered"
+    else
+        @info "Linting complete - files altered"
+        run(`git status`)
+    end
+    return nothing
+end
+
+main()