chore: use runic instead of JuliaFormatter

Author: pfitzseb

.JuliaFormatter.toml

@@ -39,24 +39,15 @@ jobs:
             ${{ runner.os }}-
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
-  julia-format:
-    name: Formatter
+  runic:
+    name: Runic formatting
     runs-on: ubuntu-latest
     steps:
-      - uses: julia-actions/setup-julia@latest
       - uses: actions/checkout@v4
-      - name: Install JuliaFormatter and format
-        run: |
-          julia --color=yes -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
-          julia --color=yes -e 'using JuliaFormatter; format(".", verbose=true)'
-      - name: Format check
-        run: |
-          julia --color=yes -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'
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1.11'
+      - uses: julia-actions/cache@v2
+      - uses: fredrikekre/runic-action@v1
+        with:
+          version: '1'

.github/workflows/CI.yml

@@ -23,12 +23,12 @@ open(joinpath(@__DIR__, "src", "index.md"), write = true) do io
         io,
         """
 
-## Docstrings
+        ## Docstrings
 
-```@autodocs
-Modules = [MultiDocumenter]
-```
-""",
+        ```@autodocs
+        Modules = [MultiDocumenter]
+        ```
+        """,
     )
 end
 cp(

docs/make.jl

@@ -5,9 +5,9 @@ using HypertextLiteral
 import Git: git
 
 module DocumenterTools
-import Gumbo, AbstractTrees
-include("documentertools/walkdocs.jl")
-include("documentertools/canonical_urls.jl")
+    import Gumbo, AbstractTrees
+    include("documentertools/walkdocs.jl")
+    include("documentertools/canonical_urls.jl")
 end
 
 """
@@ -72,14 +72,14 @@ struct MultiDocRef <: DropdownComponent
 end
 
 function MultiDocRef(;
-    upstream,
-    name,
-    path,
-    giturl = "",
-    branch = "gh-pages",
-    fix_canonical_url = true,
-)
-    MultiDocRef(upstream, path, name, fix_canonical_url, giturl, branch)
+        upstream,
+        name,
+        path,
+        giturl = "",
+        branch = "gh-pages",
+        fix_canonical_url = true,
+    )
+    return MultiDocRef(upstream, path, name, fix_canonical_url, giturl, branch)
 end
 
 """
@@ -128,6 +128,7 @@ function walk_outputs(f, root, docs::Vector, dirs::Vector{String})
             break
         end
     end
+    return
 end
 
 include("renderers.jl")
@@ -175,22 +176,22 @@ Aggregates multiple Documenter.jl-based documentation pages `docs` into `outdir`
 - `sitemap_filename` can be used to override the default sitemap filename (`sitemap.xml`)
 """
 function make(
-    outdir,
-    docs::Vector;
-    assets_dir = nothing,
-    brand_image::Union{Nothing,BrandImage} = nothing,
-    custom_stylesheets = [],
-    custom_scripts = [],
-    search_engine = DEFAULT_ENGINE,
-    prettyurls = true,
-    rootpath = "/",
-    hide_previews = true,
-    canonical_domain::Union{AbstractString,Nothing} = nothing,
-    sitemap::Bool = false,
-    sitemap_filename::AbstractString = "sitemap.xml",
-    # This keyword is for internal test use only:
-    _override_windows_isinteractive_check::Bool = false,
-)
+        outdir,
+        docs::Vector;
+        assets_dir = nothing,
+        brand_image::Union{Nothing, BrandImage} = nothing,
+        custom_stylesheets = [],
+        custom_scripts = [],
+        search_engine = DEFAULT_ENGINE,
+        prettyurls = true,
+        rootpath = "/",
+        hide_previews = true,
+        canonical_domain::Union{AbstractString, Nothing} = nothing,
+        sitemap::Bool = false,
+        sitemap_filename::AbstractString = "sitemap.xml",
+        # This keyword is for internal test use only:
+        _override_windows_isinteractive_check::Bool = false,
+    )
     if Sys.iswindows() && !isinteractive()
         if _override_windows_isinteractive_check || isinteractive()
             @warn """
@@ -214,9 +215,13 @@ function make(
     else
         !isnothing(canonical_domain)
         if !startswith(canonical_domain, r"^https?://")
-            throw(ArgumentError("""
-            Invalid value for canonical_domain: $(canonical_domain)
-            Must start with http:// or https://"""))
+            throw(
+                ArgumentError(
+                    """
+                    Invalid value for canonical_domain: $(canonical_domain)
+                    Must start with http:// or https://"""
+                )
+            )
         end
         # We'll strip any trailing /-s though, in case the user passed something like
         # https://example.org/, because we want to concatenate the file paths with `/`
@@ -337,15 +342,15 @@ function maybe_clone(docs::Vector)
             end
         end
     end
-    return nothing
+    return
 end
 
 function make_output_structure(
-    docs::Vector{DropdownComponent},
-    prettyurls,
-    hide_previews;
-    canonical::Union{AbstractString,Nothing},
-)
+        docs::Vector{DropdownComponent},
+        prettyurls,
+        hide_previews;
+        canonical::Union{AbstractString, Nothing},
+    )
     dir = mktempdir()
 
     for doc in Iterators.filter(x -> x isa MultiDocRef, docs)
@@ -381,13 +386,13 @@ function make_output_structure(
 end
 
 function make_global_nav(
-    dir,
-    docs::Vector,
-    thispagepath,
-    brand_image,
-    search_engine,
-    prettyurls,
-)
+        dir,
+        docs::Vector,
+        thispagepath,
+        brand_image,
+        search_engine,
+        prettyurls,
+    )
     nav = @htl """
     <nav id="multi-page-nav">
         $(render(brand_image, dir, thispagepath))
@@ -464,15 +469,15 @@ end
 
 
 function inject_styles_and_global_navigation(
-    dir,
-    docs::Vector,
-    brand_image,
-    custom_stylesheets,
-    custom_scripts,
-    search_engine,
-    prettyurls,
-    rootpath,
-)
+        dir,
+        docs::Vector,
+        brand_image,
+        custom_stylesheets,
+        custom_scripts,
+        search_engine,
+        prettyurls,
+        rootpath,
+    )
 
     if search_engine != false
         search_engine.engine.inject_script!(custom_scripts, rootpath)
@@ -491,9 +496,9 @@ function inject_styles_and_global_navigation(
             isfile(path) || continue
             page = read(path, String)
             if startswith(
-                page,
-                "<!--This file is automatically generated by Documenter.jl-->",
-            )
+                    page,
+                    "<!--This file is automatically generated by Documenter.jl-->",
+                )
                 continue
             end
 
@@ -521,7 +526,7 @@ function inject_styles_and_global_navigation(
                         elseif Gumbo.tag(el) == :body && !isempty(el.children)
                             documenter_div = first(el.children)
                             if documenter_div isa Gumbo.HTMLElement &&
-                               Gumbo.getattr(documenter_div, "id", "") == "documenter"
+                                    Gumbo.getattr(documenter_div, "id", "") == "documenter"
                                 @debug "Could not detect Documenter page layout in $path. This may be due to an old version of Documenter."
                             end
                             # inject global navigation as first element in body
@@ -547,6 +552,8 @@ function inject_styles_and_global_navigation(
             end
         end
     end
+
+    return
 end
 
 end

src/MultiDocumenter.jl

@@ -1,14 +1,14 @@
 # This files contains the functions used to implement the canonical URL
 # update functionality.
 function fix_canonical_url!(
-    doc::MultiDocRef;
-    canonical::Union{AbstractString,Nothing},
-    root_dir::AbstractString,
-)
+        doc::MultiDocRef;
+        canonical::Union{AbstractString, Nothing},
+        root_dir::AbstractString,
+    )
     # If the user didn't set `canonical`, then we don't need to do anything
-    isnothing(canonical) && return nothing
+    isnothing(canonical) && return
     # The user can also disable the canonical URL fixing on a per-package basis
-    doc.fix_canonical_url || return nothing
+    doc.fix_canonical_url || return
     # Determine the canonical URL and fix them in the HTML files
     documenter_directory_root = joinpath(root_dir, doc.path)
     try
@@ -20,4 +20,6 @@ function fix_canonical_url!(
         @error "Unable to update canonical URLs for this package" doc exception =
             (e, catch_backtrace())
     end
+
+    return
 end

src/canonical.jl

@@ -16,17 +16,17 @@
   specifying the root of the canonical URL.
 """
 function update_canonical_links_for_version(
-    docs_directory::AbstractString;
-    canonical::AbstractString,
-)
+        docs_directory::AbstractString;
+        canonical::AbstractString,
+    )
     canonical = rstrip(canonical, '/')
 
     walkdocs(docs_directory, isdochtml) do fileinfo
         @debug "update_canonical_links: checking $(fileinfo.relpath)"
         # Determine the
         filepath = splitpath(fileinfo.relpath)
         new_canonical_href = if filepath[end] == "index.html"
-            joinurl(canonical, filepath[1:end-1]...) * '/'
+            joinurl(canonical, filepath[1:(end - 1)]...) * '/'
         else
             joinurl(canonical, filepath[1:end]...)
         end
@@ -66,6 +66,7 @@ function update_canonical_links_for_version(
             @error "Multiple canonical tags!" file = fileinfo.relpath
         end
     end
+    return
 end
 
 is_canonical_element(e) =
@@ -123,14 +124,15 @@ function update_canonical_links(docs_directory::AbstractString; canonical::Abstr
         @debug "Updating canonical URLs for a version" path canonical_full_root
         update_canonical_links_for_version(path; canonical = canonical_full_root)
     end
+    return
 end
 
 function canonical_directory_from_redirect_index_html(docs_directory::AbstractString)
     redirect_index_html_path = joinpath(docs_directory, "index.html")
     isfile(redirect_index_html_path) || return nothing
     redirect_url = get_meta_redirect_url(redirect_index_html_path)
     isnothing(redirect_url) && return nothing
-    splitpath(normpath(redirect_url))
+    return splitpath(normpath(redirect_url))
 end
 
 """
@@ -235,16 +237,24 @@ function extract_versions_list(versions_js::AbstractString)
     versions_js_content = read(versions_js, String)
     m = match(r"var\s+DOC_VERSIONS\s*=\s*\[([0-9A-Za-z\"\s.,+-]+)\]", versions_js_content)
     if isnothing(m)
-        throw(ArgumentError("""
-        Could not find DOC_VERSIONS in $(versions_js):
-        $(versions_js_content)"""))
+        throw(
+            ArgumentError(
+                """
+                Could not find DOC_VERSIONS in $(versions_js):
+                $(versions_js_content)"""
+            )
+        )
     end
     versions = strip.(c -> isspace(c) || (c == '"'), split(m[1], ","))
     filter!(!isempty, versions)
     if isempty(versions)
-        throw(ArgumentError("""
-        DOC_VERSIONS empty in $(versions_js):
-        $(versions_js_content)"""))
+        throw(
+            ArgumentError(
+                """
+                DOC_VERSIONS empty in $(versions_js):
+                $(versions_js_content)"""
+            )
+        )
     end
     return versions
 end