fix formatting

mortenpi · mortenpi · commit 015ee31688c8 · 2023-08-24T18:10:18.000+12:00
diff --git a/src/MultiDocumenter.jl b/src/MultiDocumenter.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
 
 """
@@ -38,7 +38,14 @@ struct MultiDocRef
     branch::String
 end
 
-function MultiDocRef(; upstream, name, path, giturl = "", branch = "gh-pages", fix_canonical_url=true)
+function MultiDocRef(;
+    upstream,
+    name,
+    path,
+    giturl = "",
+    branch = "gh-pages",
+    fix_canonical_url = true,
+)
     MultiDocRef(upstream, path, name, fix_canonical_url, giturl, branch)
 end
 
@@ -130,14 +137,19 @@ function make(
     prettyurls = true,
     rootpath = "/",
     hide_previews = true,
-    canonical::Union{AbstractString, Nothing} = nothing,
+    canonical::Union{AbstractString,Nothing} = nothing,
 )
     maybe_clone(flatten_multidocrefs(docs))
 
     if !isnothing(canonical)
         canonical = rstrip(canonical, '/')
     end
-    dir = make_output_structure(flatten_multidocrefs(docs), prettyurls, hide_previews; canonical)
+    dir = make_output_structure(
+        flatten_multidocrefs(docs),
+        prettyurls,
+        hide_previews;
+        canonical,
+    )
     out_assets = joinpath(dir, "assets")
     if assets_dir !== nothing && isdir(assets_dir)
         cp(assets_dir, out_assets)
@@ -210,9 +222,11 @@ function maybe_clone(docs::Vector{MultiDocRef})
 end
 
 function make_output_structure(
-        docs::Vector{MultiDocRef}, prettyurls, hide_previews;
-        canonical::Union{AbstractString, Nothing}
-    )
+    docs::Vector{MultiDocRef},
+    prettyurls,
+    hide_previews;
+    canonical::Union{AbstractString,Nothing},
+)
     dir = mktempdir()
 
     for doc in docs
@@ -231,7 +245,7 @@ function make_output_structure(
             rm(previewpath, recursive = true)
         end
 
-        fix_canonical_url!(doc; canonical, root_dir=dir)
+        fix_canonical_url!(doc; canonical, root_dir = dir)
     end
 
     open(joinpath(dir, "index.html"), "w") do io
diff --git a/src/canonical.jl b/src/canonical.jl
@@ -1,8 +1,10 @@
 # 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
     # The user can also disable the canonical URL fixing on a per-package basis
@@ -12,9 +14,10 @@ function fix_canonical_url!(
     try
         DocumenterTools.update_canonical_links(
             documenter_directory_root;
-            canonical = join((canonical, doc.path), '/')
+            canonical = join((canonical, doc.path), '/'),
         )
     catch e
-        @error "Unable to update canonical URLs for this package" doc exception = (e, catch_backtrace())
+        @error "Unable to update canonical URLs for this package" doc exception =
+            (e, catch_backtrace())
     end
 end
diff --git a/src/documentertools/canonical_urls.jl b/src/documentertools/canonical_urls.jl
@@ -16,9 +16,9 @@
   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
@@ -49,10 +49,9 @@ function update_canonical_links_for_version(
                 e isa Gumbo.HTMLElement || continue
                 Gumbo.tag(e) == :head || continue
                 canonical_href_element = Gumbo.HTMLElement{:link}(
-                    [], e, Dict(
-                        "rel" => "canonical",
-                        "href" => new_canonical_href,
-                    )
+                    [],
+                    e,
+                    Dict("rel" => "canonical", "href" => new_canonical_href),
                 )
                 push!(e.children, canonical_href_element)
                 @debug "update_canonical_links_for_version: added new canonical_href" new_canonical_href fileinfo.relpath
@@ -69,17 +68,17 @@ function update_canonical_links_for_version(
     end
 end
 
-is_canonical_element(e) = (e isa Gumbo.HTMLElement) && (Gumbo.tag(e) == :link) && (Gumbo.getattr(e, "rel", nothing) == "canonical")
+is_canonical_element(e) =
+    (e isa Gumbo.HTMLElement) &&
+    (Gumbo.tag(e) == :link) &&
+    (Gumbo.getattr(e, "rel", nothing) == "canonical")
 joinurl(ps::AbstractString...) = join(ps, '/')
 
 """
 Takes the multi-versioned Documenter site in `docs_directory` and updates the HTML canonical URLs
 to point to `canonical`.
 """
-function update_canonical_links(
-        docs_directory::AbstractString;
-        canonical::AbstractString
-    )
+function update_canonical_links(docs_directory::AbstractString; canonical::AbstractString)
     canonical = rstrip(canonical, '/')
     docs_directory = abspath(docs_directory)
     isdir(docs_directory) || throw(ArgumentError("No such directory: $(docs_directory)"))
@@ -144,12 +143,14 @@ function get_meta_redirect_url(indexhtml_path::AbstractString)
         Gumbo.getattr(e, "http-equiv", nothing) == "refresh" || continue
         content = Gumbo.getattr(e, "content", nothing)
         if isnothing(content)
-            @warn "<meta http-equiv=\"refresh\" ...> with no content attribute" path = indexhtml_path
+            @warn "<meta http-equiv=\"refresh\" ...> with no content attribute" path =
+                indexhtml_path
             continue
         end
         m = match(r"[0-9]+;\s*url=(.*)", content)
         if isnothing(m)
-            @warn "Unable to parse content value of <meta http-equiv=\"refresh\" ...>" content path = indexhtml_path
+            @warn "Unable to parse content value of <meta http-equiv=\"refresh\" ...>" content path =
+                indexhtml_path
             continue
         end
         return m.captures[1]
@@ -161,7 +162,8 @@ function canonical_version_from_versions_js(docs_directory)
     isdir(docs_directory) || throw(ArgumentError("Not a directory: $(docs_directory)"))
     # Try to extract the list of versions from versions.js
     versions_js = joinpath(docs_directory, "versions.js")
-    isfile(versions_js) || throw(ArgumentError("versions.js is missing in $(docs_directory)"))
+    isfile(versions_js) ||
+        throw(ArgumentError("versions.js is missing in $(docs_directory)"))
     versions = map(extract_versions_list(versions_js)) do version_str
         isversion, version_number = if occursin(Base.VERSION_REGEX, version_str)
             true, VersionNumber(version_str)
@@ -212,7 +214,9 @@ function canonical_version_from_versions_js(docs_directory)
         _, idx = findmax(first, version_symlinks)
         version_symlinks[idx][2]
     elseif length(non_version_symlinks) > 1
-        error("Unable to determine the canonical path. Found multiple non-version symlinks.\n$(non_version_symlinks)")
+        error(
+            "Unable to determine the canonical path. Found multiple non-version symlinks.\n$(non_version_symlinks)",
+        )
     else
         only(non_version_symlinks)
     end
diff --git a/src/documentertools/walkdocs.jl b/src/documentertools/walkdocs.jl
@@ -13,10 +13,10 @@ Objects of this type are passed as arguments to the callback of the [`walkdocs`]
 See [`walkdocs`](@ref) for information on how to interpret the docstrings.
 """
 Base.@kwdef struct FileInfo
-    root :: String
-    filename :: String
-    relpath :: String
-    fullpath :: String
+    root::String
+    filename::String
+    relpath::String
+    fullpath::String
 end
 
 """
@@ -56,7 +56,7 @@ walkdocs(directory_root, filter = isdochtml) do fileinfo
 end
 ```
 """
-function walkdocs(f, dir::AbstractString, filter_cb = _ -> true; collect::Bool=false)
+function walkdocs(f, dir::AbstractString, filter_cb = _ -> true; collect::Bool = false)
     hasmethod(f, (FileInfo,)) || throw(MethodError(f, (FileInfo,)))
     hasmethod(filter_cb, (FileInfo,)) || throw(MethodError(filter_cb, (FileInfo,)))
 
diff --git a/test/documentertools.jl b/test/documentertools.jl
@@ -17,7 +17,10 @@ FIXTURES = joinpath(@__DIR__, "fixtures")
     end
 
     let fileinfos = []
-        rs = DocumenterTools.walkdocs(joinpath(FIXTURES, "pre"), DocumenterTools.isdochtml) do fileinfo
+        rs = DocumenterTools.walkdocs(
+            joinpath(FIXTURES, "pre"),
+            DocumenterTools.isdochtml,
+        ) do fileinfo
             push!(fileinfos, fileinfo)
             @test isabspath(fileinfo.root)
             @test isabspath(fileinfo.fullpath)
@@ -28,7 +31,7 @@ FIXTURES = joinpath(@__DIR__, "fixtures")
         @test length(fileinfos) == 6
     end
 
-    let rs = DocumenterTools.walkdocs(joinpath(FIXTURES, "pre"), collect=true) do fileinfo
+    let rs = DocumenterTools.walkdocs(joinpath(FIXTURES, "pre"), collect = true) do fileinfo
             fileinfo.root
         end
         @test length(rs) == 9
@@ -57,18 +60,22 @@ end
 
 @testset "canonical_urls" begin
     @testset "parsing versions.js" begin
-        withfiles("versions.js" => """
-            var DOC_VERSIONS = [
-                "stable",
-                "v0.27",
-                "v0.1",
-                "dev",
-            ];
-            """,
-            "v0.27" => :dir, "v0.1" => :dir, "dev" => :dir,
+        withfiles(
+            "versions.js" => """
+      var DOC_VERSIONS = [
+          "stable",
+          "v0.27",
+          "v0.1",
+          "dev",
+      ];
+      """,
+            "v0.27" => :dir,
+            "v0.1" => :dir,
+            "dev" => :dir,
             "stable" => (:symlink, "v0.27"),
         ) do path
-            @test DocumenterTools.extract_versions_list(joinpath(path, "versions.js")) == ["stable", "v0.27", "v0.1", "dev"]
+            @test DocumenterTools.extract_versions_list(joinpath(path, "versions.js")) ==
+                  ["stable", "v0.27", "v0.1", "dev"]
             @test DocumenterTools.canonical_version_from_versions_js(path) == "stable"
         end
 
@@ -78,35 +85,43 @@ end
                 "v2",
                 "dev",
             ];
-            """,
-            "v1" => :dir, "v2" => :dir, "dev" => :dir,
-        ) do path
-        @test DocumenterTools.extract_versions_list(joinpath(path, "versions.js")) == ["v1", "v2", "dev"]
+            """, "v1" => :dir, "v2" => :dir, "dev" => :dir) do path
+            @test DocumenterTools.extract_versions_list(joinpath(path, "versions.js")) ==
+                  ["v1", "v2", "dev"]
             @test DocumenterTools.canonical_version_from_versions_js(path) == "v2"
         end
     end
 
     @testset "parsing redirect index.html" begin
         mktempdir() do path
-            @test DocumenterTools.canonical_directory_from_redirect_index_html(path) === nothing
+            @test DocumenterTools.canonical_directory_from_redirect_index_html(path) ===
+                  nothing
         end
 
         mktempdir() do path
             file = joinpath(path, "index.html")
-            write(file, """
-            <!--This file is automatically generated by Documenter.jl-->
-            <meta http-equiv="refresh" content="0; url=./stable/"/>
-            """)
+            write(
+                file,
+                """
+    <!--This file is automatically generated by Documenter.jl-->
+    <meta http-equiv="refresh" content="0; url=./stable/"/>
+    """,
+            )
             @test DocumenterTools.get_meta_redirect_url(file) == "./stable/"
-            @test DocumenterTools.canonical_directory_from_redirect_index_html(path) == ["stable"]
+            @test DocumenterTools.canonical_directory_from_redirect_index_html(path) ==
+                  ["stable"]
         end
     end
 
     @testset "update_canonical_links" begin
         out = tempname()
         cp(joinpath(FIXTURES, "pre"), out)
-        @test DocumenterTools.canonical_directory_from_redirect_index_html(out) == ["stable"]
-        DocumenterTools.update_canonical_links(out; canonical = "https://example.org/this-is-test")
+        @test DocumenterTools.canonical_directory_from_redirect_index_html(out) ==
+              ["stable"]
+        DocumenterTools.update_canonical_links(
+            out;
+            canonical = "https://example.org/this-is-test",
+        )
         DocumenterTools.walkdocs(joinpath(FIXTURES, "post")) do fileinfo
             post = read(fileinfo.fullpath, String)
             changed = read(joinpath(out, fileinfo.relpath), String)
