Runic formatter (#6)

Author: lkdvos

.github/workflows/format.yml

@@ -1,30 +1,30 @@
-name: Format
+name: Runic formatting
 on:
   push:
-    branches: [master]
-    tags: [v*]
+    branches:
+      - 'master'
+      - 'release-'
+    tags:
+      - '*'
   pull_request:
-
 jobs:
-  format:
-    name: "Format Check"
+  runic:
+    name: Runic
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v2
+      - uses: actions/checkout@v5
+      # - uses: julia-actions/setup-julia@v2
+      #   with:
+      #     version: '1'
+      # - uses: julia-actions/cache@v2
+      - uses: fredrikekre/runic-action@v1
         with:
-          version: 1
-      - uses: julia-actions/cache@v2
-      - name: Install JuliaFormatter and format
-        run: |
-          using Pkg
-          Pkg.add(PackageSpec(name="JuliaFormatter", version="1"))
-          using JuliaFormatter
-          format("."; verbose=true)
-        shell: julia --color=yes {0}
-      - name: Suggest formatting changes
-        uses: reviewdog/action-suggester@v1
+          version: '1'
+          format_files: true
+        # Fail on next step instead
+        continue-on-error: ${{ github.event_name == 'pull_request' }}
+      - uses: reviewdog/action-suggester@v1
         if: github.event_name == 'pull_request'
         with:
-          tool_name: JuliaFormatter
-          fail_on_error: true
+          tool_name: Runic
+          fail_level: warning

.pre-commit-config.yaml

@@ -0,0 +1,5 @@
+repos:
+  - repo: https://github.com/fredrikekre/runic-pre-commit
+    rev: v2.0.1
+    hooks:
+      - id: runic

docs/make.jl

@@ -3,15 +3,17 @@
 #
 
 if "--help" ∈ ARGS
-    println("""
-    docs/make.jl
+    println(
+        """
+        docs/make.jl
 
-    Render the `AlgorithmsInterface.jl` documentation with optional arguments
+        Render the `AlgorithmsInterface.jl` documentation with optional arguments
 
-    Arguments
-    * `--help`              print this help and exit without rendering the documentation
-    * `--prettyurls`        toggle the pretty urls part to true, which is always set on CI
-    """)
+        Arguments
+        * `--help`              print this help and exit without rendering the documentation
+        * `--prettyurls`        toggle the pretty urls part to true, which is always set on CI
+        """
+    )
     exit(0)
 end