Add automatic formatting checks using Runic (#667)

Author: jkrumbiegel

.github/workflows/Formatting.yml

@@ -0,0 +1,22 @@
+name: Formatting
+on:
+  push:
+    branches:
+      - 'master'
+      - 'release-'
+    tags:
+      - '*'
+  pull_request:
+jobs:
+  runic:
+    name: Runic formatting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1'
+      - uses: julia-actions/cache@v2
+      - uses: fredrikekre/runic-action@v1
+        with:
+          version: '1.4'

.gitignore

@@ -1,7 +1,5 @@
 .DS_Store
-/Manifest.toml
-test/coverage/Manifest.toml
-docs/Manifest.toml
+**/Manifest.toml
 docs/build
 docs/src/democards
 docs/node_modules
@@ -10,4 +8,3 @@ docs/package-lock.json
 docs/src/changelog.md
 .vscode/settings.json
 /scratch
-/_readme/Manifest.toml

_readme/make.jl

@@ -6,4 +6,4 @@ Pkg.precompile()
 
 run(`quarto render README.qmd`)
 mv("README.md", "../README.md", force = true)
-mv("README_files/", "../README_files/", force = true)
+mv("README_files/", "../README_files/", force = true)

docs/make.jl

@@ -4,7 +4,7 @@ using DocumenterVitepress
 using Literate, Glob
 using CairoMakie
 
-DocMeta.setdocmeta!(AlgebraOfGraphics, :DocTestSetup, :(using AlgebraOfGraphics); recursive=true)
+DocMeta.setdocmeta!(AlgebraOfGraphics, :DocTestSetup, :(using AlgebraOfGraphics); recursive = true)
 
 cp(joinpath(@__DIR__, "..", "CHANGELOG.md"), joinpath(@__DIR__, "src", "changelog.md"), force = true)
 

examples/gui.jl

@@ -11,45 +11,47 @@ using AlgebraOfGraphics: linear, smooth, density, AlgebraicList, layoutplot!
 
 function clean!(g::GridLayout)
     foreach(delete!, Any, g)
-    foreach(GridLayoutBase.remove_from_gridlayout!, g.content)
+    return foreach(GridLayoutBase.remove_from_gridlayout!, g.content)
 end
 
 function gui!(scene, layout, df)
     table = data(df)
 
     plot_options = [("none", nothing), ("scatter", Scatter), ("lines", Lines), ("barplot", BarPlot)]
-    plot_menu = LMenu(scene, options = plot_options, textsize=30, width=500)
+    plot_menu = LMenu(scene, options = plot_options, textsize = 30, width = 500)
 
-    layout[1, 1] = Label(scene, "plot type", fontsize=30)
+    layout[1, 1] = Label(scene, "plot type", fontsize = 30)
     layout[1, 2] = plot_menu
 
-    analysis_options = [("none", nothing), ("linear", linear), ("smooth", smooth),
-        ("density", density)]
+    analysis_options = [
+        ("none", nothing), ("linear", linear), ("smooth", smooth),
+        ("density", density),
+    ]
 
-    analysis_menu = LMenu(scene, options = analysis_options, textsize=30, width=500)
+    analysis_menu = LMenu(scene, options = analysis_options, textsize = 30, width = 500)
 
-    layout[2, 1] = Label(scene, "analysis", fontsize=30)
+    layout[2, 1] = Label(scene, "analysis", fontsize = 30)
     layout[2, 2] = analysis_menu
 
     axis_options = vcat([("None", nothing)], [(s, Symbol(s)) for s in propertynames(table.data)])
 
     mappings = ["x", "y", "color", "marker", "markersize", "linestyle", "layout_x", "layout_y"]
-    mapping_menus = [LMenu(scene, options=axis_options, textsize=30, width=500) for mapping in mappings]
+    mapping_menus = [LMenu(scene, options = axis_options, textsize = 30, width = 500) for mapping in mappings]
     N = length(mappings)
 
     for i in 1:N
-        layout[2+i, 1] = Label(scene, mappings[i], fontsize=30)
-        layout[2+i, 2] = mapping_menus[i]
+        layout[2 + i, 1] = Label(scene, mappings[i], fontsize = 30)
+        layout[2 + i, 2] = mapping_menus[i]
     end
 
-    plot_button = Button(scene, label="Plot", textsize=30)
-    add_and_plot_button = Button(scene, label="Add and Plot", buttoncolor="powderblue", textsize=30)
+    plot_button = Button(scene, label = "Plot", textsize = 30)
+    add_and_plot_button = Button(scene, label = "Add and Plot", buttoncolor = "powderblue", textsize = 30)
 
     layout[1, 3] = plot_button
     layout[1, 4] = add_and_plot_button
 
-    axs = layout[1:2+N, 5] = GridLayout(1, 2) # for plot and legend
-    colsize!(axs, 2, Relative(1/5)) # make legend a fourth of the plot's width
+    axs = layout[1:(2 + N), 5] = GridLayout(1, 2) # for plot and legend
+    colsize!(axs, 2, Relative(1 / 5)) # make legend a fourth of the plot's width
 
     state = AlgebraicList()
 
@@ -66,7 +68,7 @@ function gui!(scene, layout, df)
         end
         clean!(axs)
         state += acc
-        layoutplot!(scene, axs, state)
+        return layoutplot!(scene, axs, state)
     end
 
     on(plot_button.clicks) do _

ext/AlgebraOfGraphicsDynamicQuantitiesExt.jl

@@ -6,17 +6,17 @@ const DQ = DynamicQuantities
 
 AlgebraOfGraphics.extrema_finite(v::AbstractVector{<:DQ.Quantity}) = extrema(Iterators.filter(isfinite, skipmissing(v)))
 
-struct DimensionMismatch{X1,X2} <: Exception
+struct DimensionMismatch{X1, X2} <: Exception
     x1::X1
     x2::X2
 end
 
-dimensionless(x, u::DQ.Quantity{<:Any,<:DQ.SymbolicDimensions}) = DQ.ustrip(DQ.uconvert(u, x))
-function dimensionless(x, u::DQ.Quantity{<:Any,<:DQ.Dimensions})
+dimensionless(x, u::DQ.Quantity{<:Any, <:DQ.SymbolicDimensions}) = DQ.ustrip(DQ.uconvert(u, x))
+function dimensionless(x, u::DQ.Quantity{<:Any, <:DQ.Dimensions})
     xexp = DQ.uexpand(x)
     uexp = DQ.uexpand(u)
     DQ.dimension(xexp) == DQ.dimension(uexp) || throw(DimensionMismatch(x, u))
-    DQ.ustrip(xexp)
+    return DQ.ustrip(xexp)
 end
 
 function AlgebraOfGraphics.strip_units(scale, data::AbstractVector{<:DQ.Quantity})
@@ -29,10 +29,10 @@ end
 AlgebraOfGraphics.is_unit(::DynamicQuantities.Quantity) = true # there seems to be no FreeUnits equivalent in DQ
 
 function AlgebraOfGraphics.unit_string(u::DQ.Quantity)
-    string(DQ.dimension(u))
+    return string(DQ.dimension(u))
 end
 
-function AlgebraOfGraphics.getunit(scale::AlgebraOfGraphics.ContinuousScale{T}) where T <: DynamicQuantities.Quantity
+function AlgebraOfGraphics.getunit(scale::AlgebraOfGraphics.ContinuousScale{T}) where {T <: DynamicQuantities.Quantity}
     o1, o2 = oneunit.(scale.extrema)
     o1 == o2 || error("Different ones $o1 $o2")
     o = o1
@@ -47,7 +47,7 @@ function AlgebraOfGraphics.getunit(scale::AlgebraOfGraphics.ContinuousScale{T})
 end
 
 function AlgebraOfGraphics.dimensionally_compatible(q1::DynamicQuantities.Quantity, q2::DynamicQuantities.Quantity)
-    try
+    return try
         # because we can't uconvert to Dimensions its not super straightforward
         # to check if the units are compatible, so we reuse the conversion mechanism
         dimensionless(q1, q2)
@@ -61,4 +61,4 @@ function AlgebraOfGraphics.dimensionally_compatible(q1::DynamicQuantities.Quanti
     end
 end
 
-end
+end

ext/AlgebraOfGraphicsUnitfulExt.jl

@@ -11,12 +11,12 @@ function AlgebraOfGraphics.strip_units(scale, data::AbstractVector{<:Unitful.Qua
 end
 
 function AlgebraOfGraphics.unit_string(u::Unitful.FreeUnits)
-    string(u)
+    return string(u)
 end
 
 AlgebraOfGraphics.is_unit(::Unitful.FreeUnits) = true
 
-function AlgebraOfGraphics.getunit(scale::AlgebraOfGraphics.ContinuousScale{T}) where T <: Unitful.Quantity
+function AlgebraOfGraphics.getunit(scale::AlgebraOfGraphics.ContinuousScale{T}) where {T <: Unitful.Quantity}
     u = Unitful.unit(eltype(scale.extrema))
     if scale.props.unit === nothing
         return u
@@ -30,7 +30,7 @@ function AlgebraOfGraphics.getunit(scale::AlgebraOfGraphics.ContinuousScale{T})
 end
 
 function AlgebraOfGraphics.dimensionally_compatible(u1::Unitful.FreeUnits, u2::Unitful.FreeUnits)
-    Unitful.dimension(u1) == Unitful.dimension(u2)
+    return Unitful.dimension(u1) == Unitful.dimension(u2)
 end
 
-end
+end

src/AlgebraOfGraphics.jl

@@ -11,11 +11,11 @@ using PlotUtils: AbstractColorList
 using Makie
 using Makie: current_default_theme, to_value, automatic, Automatic, Block, ATTRIBUTES
 import Makie: hidexdecorations!,
-              hideydecorations!,
-              hidedecorations!,
-              linkaxes!,
-              linkxaxes!,
-              linkyaxes!
+    hideydecorations!,
+    hidedecorations!,
+    linkaxes!,
+    linkxaxes!,
+    linkyaxes!
 using GridLayoutBase: update!, Protrusion, protrusionsobservable
 using PooledArrays: PooledArray
 using Dictionaries: AbstractDictionary, Dictionary, Indices, getindices, set!, dictionary