Merge pull request #135 from IntegralEquations/runic-format

Switch to Runic.jl for formatting.

Author: maltezfaria

.JuliaFormatter.toml

@@ -0,0 +1,6 @@
+# This file contains a list of commits that should be ignored by git blame.
+# To use this file, run: git config blame.ignoreRevsFile .git-blame-ignore-revs
+# See: https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revs-fileltfilegt
+
+# Format all code with Runic.jl (replacing JuliaFormatter)
+8169f14c015561f0af30f67b3b8ab3697202b7e0

.git-blame-ignore-revs

@@ -8,36 +8,13 @@ on:
   pull_request:
 
 jobs:
-  build:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        version:
-          - '1'
-        os:
-          - ubuntu-latest
-        arch:
-          - x64
+  runic:
+    runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v5
       - uses: julia-actions/setup-julia@latest
         with:
-          version: ${{ matrix.version }}
-
-      - uses: actions/checkout@v5
-      - name: Install JuliaFormatter and format
-        run: |
-          julia  -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
-          julia  -e 'using JuliaFormatter; format(".", verbose=true)'
-      - name: Format check
-        run: |
-          julia -e '
-          out = Cmd(`git diff --name-only`) |> read |> String
-          if out == ""
-              exit(0)
-          else
-              @error "Some files have not been formatted !!!"
-              write(stdout, out)
-              exit(1)
-          end'
-      
-
+          version: '1'
+      - uses: fredrikekre/runic-action@v1
+        with:
+          version: '1'

.github/workflows/format_check.yml

@@ -7,10 +7,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
-      - name: Install JuliaFormatter and format
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: '1'
+      - name: Install Runic and format
         run: |
-          julia  -e 'import Pkg; Pkg.add("JuliaFormatter")'
-          julia  -e 'using JuliaFormatter; format(".")'
+          julia --project=@runic -e 'import Pkg; Pkg.add("Runic")'
+          julia --project=@runic -e 'using Runic; Runic.main(["--inplace", "."])'
 
       # https://github.com/marketplace/actions/create-pull-request
       # https://github.com/peter-evans/create-pull-request#reference-example
@@ -19,9 +22,9 @@ jobs:
         uses: peter-evans/create-pull-request@v7
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          commit-message: Format .jl files
-          title: 'Automatic JuliaFormatter.jl run'
-          branch: auto-juliaformatter-pr
+          commit-message: Format .jl files with Runic
+          title: 'Automatic Runic.jl run'
+          branch: auto-runic-pr
           delete-branch: true
           labels: formatting, automated pr, no changelog
       - name: Check outputs

.github/workflows/format_pr.yml

@@ -11,6 +11,7 @@
 /docs/src/pluto-examples/*.md
 /sandbox/*
 /talks/*
+/test/vtk_output/*
 
 .markdownlint.json
 Inti.code-workspace

.gitignore

@@ -5,6 +5,7 @@
 [![Build Status](https://github.com/IntegralEquations/Inti.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/IntegralEquations/Inti.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![codecov](https://codecov.io/gh/IntegralEquations/Inti.jl/graph/badge.svg?token=2VF6BR8LA0)](https://codecov.io/gh/IntegralEquations/Inti.jl)
 [![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://inti.zulipchat.com)
+[![Runic](https://img.shields.io/badge/code%20style-runic-hotpink.svg)](https://github.com/fredrikekre/Runic.jl)
 [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 
 A package for efficient and high-order discretization and application of

README.md

@@ -10,13 +10,13 @@ Gmsh = "705231aa-382f-11e9-3f0c-b7cb4346fdeb"
 HMatrices = "8646bddf-ab1c-4fa7-9c51-ba187d647618"
 Inti = "fb74042b-437e-4c5b-88cf-d4e2beb394d5"
 IterativeSolvers = "42fd0dbc-a981-5370-80f2-aaf504508153"
-JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
 KrylovKit = "0b1a1467-8014-51b9-945f-bf0ae24f4b77"
 LinearMaps = "7a12625a-238d-50fd-b39a-03d52299707e"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 Meshes = "eacbb407-ea5a-433e-ab97-5258b1ca43fa"
 Pluto = "c3e4b0f8-55cb-11ea-2926-15256bba5781"
 PlutoUI = "7f904dfe-b85e-4ff6-b463-dae2292396a8"
+Runic = "62bfec6d-59d7-401d-8490-b29ee721c001"
 SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 WriteVTK = "64499a7a-5c06-52f2-abe2-ccb03c286192"

docs/Project.toml

@@ -3,7 +3,7 @@ using Documenter
 using DocumenterCitations
 using DocumenterInterLinks
 using Pluto
-using JuliaFormatter
+using Runic
 # packages needed for extensions
 using Gmsh
 using HMatrices
@@ -19,13 +19,13 @@ ON_CI && (draft = false) # always full build on CI
 
 # from https://github.com/fonsp/Pluto.jl/pull/2471
 function generate_plaintext(
-    notebook,
-    strmacrotrim::Union{String,Nothing} = nothing;
-    header::Function = _ -> nothing,
-    footer::Function = _ -> nothing,
-    textcomment::Function = identity,
-    codewrapper::Function,
-)
+        notebook,
+        strmacrotrim::Union{String, Nothing} = nothing;
+        header::Function = _ -> nothing,
+        footer::Function = _ -> nothing,
+        textcomment::Function = identity,
+        codewrapper::Function,
+    )
     cell_strings = String[]
     header_content = header(notebook)
     isnothing(header_content) || push!(cell_strings, header_content)
@@ -64,17 +64,17 @@ function generate_md(input; output = replace(input, r"\.jl$" => ".md"))
     notebook = Pluto.load_notebook(input)
     header =
         _ ->
-            "[![Pluto notebook](https://img.shields.io/badge/download-Pluto_notebook-blue)]($fname)"
+    "[![Pluto notebook](https://img.shields.io/badge/download-Pluto_notebook-blue)]($fname)"
 
     function codewrapper(cell, _)
         # 1. Strips begin/end block
-        # 2. Reformats code using JuliaFormatter
+        # 2. Reformats code using Runic
         # 3. Wraps all code in same ```@example``` block for documenter
         code = strip(cell.code)
         if startswith(code, "begin") && endswith(code, "end")
-            code = strip(code[6:end-4])  # Remove "begin" and "end" and strip spaces
-            # reformat code using JuliaFormatter
-            code = format_text(String(code))
+            code = strip(code[6:(end - 4)])  # Remove "begin" and "end" and strip spaces
+            # reformat code using Runic
+            code = Runic.format_string(String(code))
         end
         return if cell.code_folded
             string("```@setup $fname\n", code, "\n```")
@@ -117,7 +117,7 @@ notebooks = [
     "Poisson problem" => "poisson.jl",
 ]
 
-notebook_examples = Pair{String,String}[]
+notebook_examples = Pair{String, String}[]
 for notebook in notebooks
     title, fname = notebook
     file_in = joinpath(@__DIR__, "src", "pluto-examples", fname)

docs/make.jl

@@ -113,8 +113,8 @@ using LinearMaps
 
 # and setup some of the (global) problem parameters:
 
-k      = 4π
-λ      = 2π / k
+k = 4π
+λ = 2π / k
 qorder = 4 # quadrature order
 gorder = 2 # order of geometrical approximation
 nothing #hide
@@ -127,7 +127,7 @@ nothing #hide
 # function to mesh the circle:
 
 function gmsh_circle(; name, meshsize, order = 1, radius = 1, center = (0, 0))
-    try
+    return try
         gmsh.initialize()
         gmsh.model.add("circle-mesh")
         gmsh.option.setNumber("Mesh.MeshSizeMax", meshsize)
@@ -190,7 +190,7 @@ nothing #hide
 # integrating the function `x->1` over `Q` gives an approximation to the
 # perimeter:
 
-@assert abs(Inti.integrate(x -> 1, Q) - 2π) < 1e-5 #hide
+@assert abs(Inti.integrate(x -> 1, Q) - 2π) < 1.0e-5 #hide
 abs(Inti.integrate(x -> 1, Q) - 2π)
 
 # With the [`Quadrature`](@ref Inti.Quadrature) constructed, we now can define
@@ -260,7 +260,7 @@ nothing #hide
 # potentials, and then combine them as follows:
 
 𝒮, 𝒟 = Inti.single_double_layer_potential(; op, source = Q)
-uₛ   = x -> 𝒟[σ](x) - im * k * 𝒮[σ](x)
+uₛ = x -> 𝒟[σ](x) - im * k * 𝒮[σ](x)
 nothing #hide
 
 # The variable `uₛ` is an anonymous/lambda function representing the approximate
@@ -277,9 +277,9 @@ function circle_helmholtz_soundsoft(pt; radius = 1, k, θin)
     u = 0.0
     r < radius && return u
     c(n) = -exp(im * n * (π / 2 - θin)) * besselj(n, k * radius) / besselh(n, k * radius)
-    u    = c(0) * besselh(0, k * r)
-    n    = 1
-    while (abs(c(n)) > 1e-12)
+    u = c(0) * besselh(0, k * r)
+    n = 1
+    while (abs(c(n)) > 1.0e-12)
         u +=
             c(n) * besselh(n, k * r) * exp(im * n * θ) +
             c(-n) * besselh(-n, k * r) * exp(-im * n * θ)
@@ -297,7 +297,7 @@ er = maximum(0:0.01:2π) do θ
     x = (R * cos(θ), R * sin(θ))
     return abs(uₛ(x) - uₑ(x))
 end
-@assert er < 1e-3 #hide
+@assert er < 1.0e-3 #hide
 @info "maximum error = $er"
 
 # As we can see, the error is quite small! Let's use `Makie` to visualize the solution in this
@@ -450,15 +450,15 @@ S, D = Inti.single_double_layer(;
     op,
     target = Q,
     source = Q,
-    compression = (method = :hmatrix, tol = 1e-4),
+    compression = (method = :hmatrix, tol = 1.0e-4),
     correction = (method = :dim,),
 )
 nothing #hide
 
 # Here is how much memory it would take to store the dense representation of
 # these matrices:
 
-mem = 2 * length(S) * 16 / 1e9 # 16 bytes per complex number, 1e9 bytes per GB, two matrices
+mem = 2 * length(S) * 16 / 1.0e9 # 16 bytes per complex number, 1e9 bytes per GB, two matrices
 println("memory required to store S and D: $(mem) GB")
 
 # Even for this simple example, the dense representation of the integral
@@ -492,7 +492,7 @@ rhs = map(Q) do q
     return -uᵢ(x)
 end
 σ, hist =
-    gmres(L, rhs; log = true, abstol = 1e-6, verbose = false, restart = 100, maxiter = 100)
+    gmres(L, rhs; log = true, abstol = 1.0e-6, verbose = false, restart = 100, maxiter = 100)
 @show hist
 
 # As before, let us represent the solution using `IntegralPotential`s:
@@ -517,7 +517,7 @@ function sphere_helmholtz_soundsoft(xobs; radius = 1, k = 1, θin = 0, ϕin = 0)
     r < radius && return u
     function c(l, m)
         return -4π * im^l * sphharmonic(l, -m, θin, ϕin) * sphbesselj(l, k * radius) /
-               sphbesselh(l, k * radius)
+            sphbesselh(l, k * radius)
     end
     l = 0
     for l in 0:60
@@ -538,7 +538,7 @@ er = maximum(1:100) do _
     x = 2 * x̂
     return abs(uₛ(x) - uₑ(x))
 end
-@assert er < 1e-3 #hide
+@assert er < 1.0e-3 #hide
 @info "error with correction = $er"
 
 # We see that, once again, the approximation is quite accurate. Let us now
@@ -553,7 +553,7 @@ S, D = Inti.single_double_layer(;
     op,
     target,
     source = Q,
-    compression = (method = :hmatrix, tol = 1e-4),
+    compression = (method = :hmatrix, tol = 1.0e-4),
     ## correction for the nearfield (for visual purposes, set to `:none` to disable)
     correction = (method = :dim, maxdist = meshsize, target_location = :outside),
 )

docs/src/examples/helmholtz_scattering.jl

@@ -52,7 +52,7 @@ nothing # hide
 using Gmsh # this will trigger the loading of Inti's Gmsh extension
 
 function gmsh_disk(; name, meshsize, order = 1, center = (0, 0), paxis = (1, 1))
-    try
+    return try
         gmsh.initialize()
         gmsh.option.setNumber("General.Terminal", 0)
         gmsh.model.add("circle-mesh")
@@ -94,7 +94,7 @@ V_d2d = Inti.volume_potential(;
     op,
     target = Ωₕ_quad,
     source = Ωₕ_quad,
-    compression = (method = :fmm, tol = 1e-7),
+    compression = (method = :fmm, tol = 1.0e-7),
     correction = (method = :dim, interpolation_order),
 )
 
@@ -121,13 +121,13 @@ L = I + k₁^2 * V_d2d * Lη
 # The unknown volumetric field $u$:
 using IterativeSolvers
 u, hist =
-    gmres(L, rhs; log = true, abstol = 1e-7, verbose = false, restart = 200, maxiter = 200)
+    gmres(L, rhs; log = true, abstol = 1.0e-7, verbose = false, restart = 200, maxiter = 200)
 @show hist
 
 𝒱 = Inti.IntegralPotential(Inti.SingleLayerKernel(op), Ωₕ_quad)
 
 # The representation formula gives the solution in $\R^2 \setminus \Omega$:
-uˢ = (x) -> uⁱ(x) - k₁^2 * 𝒱[refr_map_d.*u](x)
+uˢ = (x) -> uⁱ(x) - k₁^2 * 𝒱[refr_map_d .* u](x)
 nothing # hide
 
 # To visualize the solution using Gmsh, let's query it at the triangle vertices  in $\Omega$