Format code base with runic and set up runic CI (#4320)

Author: IanButterworth

.github/workflows/check.yml

@@ -0,0 +1,30 @@
+name: Code checks
+
+on:
+  pull_request:
+  push:
+    branches: ["master"]
+
+jobs:
+
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
+        env:
+          # Skip runic-pre-commit since we use runic-action below instead
+          SKIP: runic
+
+  runic:
+    name: "Runic"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1.11'
+      - uses: julia-actions/cache@v2
+      - uses: fredrikekre/runic-action@v1
+        with:
+          version: "1.4" # Keep version in sync with .pre-commit-config.yaml

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: 'https://github.com/pre-commit/pre-commit-hooks'
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      # - id: check-toml # we have tomls with invalid syntax for tests
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+  - repo: 'https://github.com/fredrikekre/runic-pre-commit'
+    rev: v2.0.1
+    hooks:
+      - id: runic
+        additional_dependencies:
+          - '[email protected]' # Keep version in sync with .github/workflows/Check.yml

contrib/list_missing_pkg_tags.jl

@@ -7,7 +7,7 @@ const PKG_REPO_URL = "https://github.com/JuliaLang/Pkg.jl.git"
 const PKG_REPO_DIR = "Pkg.jl"
 
 function checkout_or_update_repo(url, dir)
-    if isdir(dir)
+    return if isdir(dir)
         println("Updating existing repository: $dir")
         repo = LibGit2.GitRepo(dir)
         LibGit2.fetch(repo)
@@ -33,7 +33,7 @@ function extract_pkg_sha1(text::AbstractString)
 end
 
 function get_commit_hash_for_pkg_version(repo, tag)
-    try
+    return try
         tag_ref = LibGit2.GitReference(repo, "refs/tags/" * tag)
         LibGit2.checkout!(repo, string(LibGit2.GitHash(LibGit2.peel(tag_ref))))
         version_file = joinpath(JULIA_REPO_DIR, PKG_VERSION_PATH)
@@ -78,7 +78,7 @@ cd(tempdir) do
     missing_versions = filter(v -> v ∉ pkg_tags, collect(keys(version_commit_map)))
 
     # Sort versions numerically
-    sort!(missing_versions, by=VersionNumber)
+    sort!(missing_versions, by = VersionNumber)
 
     # Generate `git tag` commands
     println("\nGit tag commands for missing Pkg.jl versions:")

docs/NEWS-update.jl

@@ -7,11 +7,11 @@ s = read(NEWS, String)
 
 m = match(r"\[#[0-9]+\]:", s)
 if m !== nothing
-    s = s[1:m.offset-1]
+    s = s[1:(m.offset - 1)]
 end
 
 footnote(n) = "[#$n]: https://github.com/JuliaLang/Pkg.jl/issues/$n"
-N = map(m -> parse(Int,m.captures[1]), eachmatch(r"\[#([0-9]+)\]", s))
+N = map(m -> parse(Int, m.captures[1]), eachmatch(r"\[#([0-9]+)\]", s))
 foots = join(map(footnote, sort!(unique(N))), "\n")
 
 open(NEWS, "w") do f

docs/generate.jl

@@ -4,38 +4,42 @@
 
 function generate(io, command)
     cmd_nospace = replace(command, " " => "-")
-    println(io, """
-    ```@raw html
-    <article class="docstring">
-        <header>
-            <a class="docstring-binding" id="repl-$(cmd_nospace)" href="#repl-$(cmd_nospace)">
-                <code>$(command)</code>
-            </a>
-            —
-            <span class="docstring-category">REPL command</span>
-        </header>
-        <section>
-    ```
-    ```@eval
-    using Pkg
-    Dict(Pkg.REPLMode.canonical_names())["$(command)"].help
-    ```
-    ```@raw html
-        </section>
-    </article>
-    ```
-    """)
+    return println(
+        io, """
+        ```@raw html
+        <article class="docstring">
+            <header>
+                <a class="docstring-binding" id="repl-$(cmd_nospace)" href="#repl-$(cmd_nospace)">
+                    <code>$(command)</code>
+                </a>
+                —
+                <span class="docstring-category">REPL command</span>
+            </header>
+            <section>
+        ```
+        ```@eval
+        using Pkg
+        Dict(Pkg.REPLMode.canonical_names())["$(command)"].help
+        ```
+        ```@raw html
+            </section>
+        </article>
+        ```
+        """
+    )
 end
 function generate()
     io = IOBuffer()
-    println(io, """
+    println(
+        io, """
         # [**11.** REPL Mode Reference](@id REPL-Mode-Reference)
 
         This section describes available commands in the Pkg REPL.
         The Pkg REPL mode is mostly meant for interactive use,
         and for non-interactive use it is recommended to use the
         functional API, see [API Reference](@ref API-Reference).
-        """)
+        """
+    )
     # list commands
     println(io, "## `package` commands")
     foreach(command -> generate(io, command), ["add", "build", "compat", "develop", "free", "generate", "pin", "remove", "test", "update"])

docs/make.jl

@@ -17,7 +17,7 @@ if "pdf" in ARGS
 end
 
 # setup for doctesting
-DocMeta.setdocmeta!(Pkg.BinaryPlatforms, :DocTestSetup, :(using Base.BinaryPlatforms); recursive=true)
+DocMeta.setdocmeta!(Pkg.BinaryPlatforms, :DocTestSetup, :(using Base.BinaryPlatforms); recursive = true)
 
 # Run doctests first and disable them in makedocs
 Documenter.doctest(joinpath(@__DIR__, "src"), [Pkg])

docs/src/creating-packages.md

@@ -627,7 +627,7 @@ may fit your package better.
      * The package name should begin with a capital letter and word separation is shown with upper camel case
      * Packages that provide the functionality of a project from another language should use the Julia convention
      * Packages that [provide pre-built libraries and executables](https://docs.binarybuilder.org/stable/jll/) can keep their original name, but should get `_jll`as a suffix. For example `pandoc_jll` wraps pandoc. However, note that the generation and release of most JLL packages is handled by the [Yggdrasil](https://github.com/JuliaPackaging/Yggdrasil) system.
-  
+
 10. For the complete list of rules for automatic merging into the General registry, see [these guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/).
 
 

docs/src/protocol.md

@@ -13,7 +13,7 @@ The protocols also aim to address some of the limitations that existed prior to
 
 ## Protocols & Services
 
-1. **Pkg Protocol:** what Julia Pkg Clients speak to Pkg Servers. The Pkg Server serves all resources that Pkg Clients need to install and use registered packages, including registry data, packages and artifacts. It is designed to be easily horizontally scalable and not to have any hard operational requirements: if service is slow, just start more servers; if a Pkg Server crashes, forget it and boot up a new one.  
+1. **Pkg Protocol:** what Julia Pkg Clients speak to Pkg Servers. The Pkg Server serves all resources that Pkg Clients need to install and use registered packages, including registry data, packages and artifacts. It is designed to be easily horizontally scalable and not to have any hard operational requirements: if service is slow, just start more servers; if a Pkg Server crashes, forget it and boot up a new one.
 2. **Storage Protocol:** what Pkg Servers speak to get resources from Storage Services. Julia clients do not interact with Storage services directly and multiple independent Storage Services can symmetrically (all are treated equally) provide their service to a given Pkg Server. Since Pkg Servers cache what they serve to Clients and handle convenient content presentation, Storage Services can expose a much simpler protocol: all they do is serve up complete versions of registries, packages and artifacts, while guaranteeing persistence and completeness. Persistence means: once a version of a resource has been served, that version can be served forever. Completeness means: if the service serves a registry, it can serve all package versions referenced by that registry; if it serves a package version, it can serve all artifacts used by that package.
 
 Both protocols work over HTTPS, using only GET and HEAD requests. As is normal for HTTP, HEAD requests are used to get information about a resource, including whether it would be served, without actually downloading it. As described in what follows, the Pkg Protocol is client-to-server and may be unauthenticated, use basic auth, or OpenID; the Storage Protocol is server-to-server only and uses mutual authentication with TLS certificates.

ext/REPLExt/REPLExt.jl

@@ -30,7 +30,7 @@ include("compat.jl")
 
 struct PkgCompletionProvider <: LineEdit.CompletionProvider end
 
-function LineEdit.complete_line(c::PkgCompletionProvider, s; hint::Bool=false)
+function LineEdit.complete_line(c::PkgCompletionProvider, s; hint::Bool = false)
     partial = REPL.beforecursor(s.input_buffer)
     full = LineEdit.input_string(s)
     ret, range, should_complete = completions(full, lastindex(partial); hint)
@@ -120,16 +120,18 @@ function on_done(s, buf, ok, repl)
     do_cmds(repl, input)
     REPL.prepare_next(repl)
     REPL.reset_state(s)
-    s.current_mode.sticky || REPL.transition(s, main)
+    return s.current_mode.sticky || REPL.transition(s, main)
 end
 
 # Set up the repl Pkg REPLMode
 function create_mode(repl::REPL.AbstractREPL, main::LineEdit.Prompt)
-    pkg_mode = LineEdit.Prompt(promptf;
+    pkg_mode = LineEdit.Prompt(
+        promptf;
         prompt_prefix = repl.options.hascolor ? Base.text_colors[:blue] : "",
         prompt_suffix = "",
         complete = PkgCompletionProvider(),
-        sticky = true)
+        sticky = true
+    )
 
     pkg_mode.repl = repl
     hp = main.hist
@@ -152,9 +154,9 @@ function create_mode(repl::REPL.AbstractREPL, main::LineEdit.Prompt)
 
     repl_keymap = Dict()
     if shell_mode !== nothing
-        let shell_mode=shell_mode
-            repl_keymap[';'] = function (s,o...)
-                if isempty(s) || position(LineEdit.buffer(s)) == 0
+        let shell_mode = shell_mode
+            repl_keymap[';'] = function (s, o...)
+                return if isempty(s) || position(LineEdit.buffer(s)) == 0
                     buf = copy(LineEdit.buffer(s))
                     LineEdit.transition(s, shell_mode) do
                         LineEdit.state(s, shell_mode).input_buffer = buf
@@ -167,9 +169,9 @@ function create_mode(repl::REPL.AbstractREPL, main::LineEdit.Prompt)
         end
     end
 
-    b = Dict{Any,Any}[
+    b = Dict{Any, Any}[
         skeymap, repl_keymap, mk, prefix_keymap, LineEdit.history_keymap,
-        LineEdit.default_keymap, LineEdit.escape_defaults
+        LineEdit.default_keymap, LineEdit.escape_defaults,
     ]
     pkg_mode.keymap_dict = LineEdit.keymap(b)
     return pkg_mode
@@ -179,9 +181,9 @@ function repl_init(repl::REPL.LineEditREPL)
     main_mode = repl.interface.modes[1]
     pkg_mode = create_mode(repl, main_mode)
     push!(repl.interface.modes, pkg_mode)
-    keymap = Dict{Any,Any}(
-        ']' => function (s,args...)
-            if isempty(s) || position(LineEdit.buffer(s)) == 0
+    keymap = Dict{Any, Any}(
+        ']' => function (s, args...)
+            return if isempty(s) || position(LineEdit.buffer(s)) == 0
                 buf = copy(LineEdit.buffer(s))
                 LineEdit.transition(s, pkg_mode) do
                     LineEdit.state(s, pkg_mode).input_buffer = buf
@@ -208,9 +210,9 @@ function try_prompt_pkg_add(pkgs::Vector{Symbol})
     end
     if isempty(ctx.registries)
         if !REG_WARNED[]
-            printstyled(ctx.io, " │ "; color=:green)
+            printstyled(ctx.io, " │ "; color = :green)
             printstyled(ctx.io, "Attempted to find missing packages in package registries but no registries are installed.\n")
-            printstyled(ctx.io, " └ "; color=:green)
+            printstyled(ctx.io, " └ "; color = :green)
             printstyled(ctx.io, "Use package mode to install a registry. `pkg> registry add` will install the default registries.\n\n")
             REG_WARNED[] = true
         end
@@ -230,22 +232,22 @@ function try_prompt_pkg_add(pkgs::Vector{Symbol})
         available_pkg_list = length(available_pkgs) == 1 ? String(available_pkgs[1]) : "[$(join(available_pkgs, ", "))]"
         msg1 = "Package$(plural1) $(missing_pkg_list) not found, but $(plural2) named $(available_pkg_list) $(plural3) available from a registry."
         for line in linewrap(msg1, io = ctx.io, padding = length(" │ "))
-            printstyled(ctx.io, " │ "; color=:green)
+            printstyled(ctx.io, " │ "; color = :green)
             println(ctx.io, line)
         end
-        printstyled(ctx.io, " │ "; color=:green)
+        printstyled(ctx.io, " │ "; color = :green)
         println(ctx.io, "Install package$(plural4)?")
         msg2 = string("add ", join(available_pkgs, ' '))
         for (i, line) in pairs(linewrap(msg2; io = ctx.io, padding = length(string(" |   ", promptf()))))
-            printstyled(ctx.io, " │   "; color=:green)
+            printstyled(ctx.io, " │   "; color = :green)
             if i == 1
-                printstyled(ctx.io, promptf(); color=:blue)
+                printstyled(ctx.io, promptf(); color = :blue)
             else
                 print(ctx.io, " "^length(promptf()))
             end
             println(ctx.io, line)
         end
-        printstyled(ctx.io, " └ "; color=:green)
+        printstyled(ctx.io, " └ "; color = :green)
         Base.prompt(stdin, ctx.io, "(y/n/o)", default = "y")
     catch err
         if err isa InterruptException # if ^C is entered
@@ -261,7 +263,7 @@ function try_prompt_pkg_add(pkgs::Vector{Symbol})
     resp = strip(resp)
     lower_resp = lowercase(resp)
     if lower_resp in ["y", "yes"]
-        API.add(string.(available_pkgs); allow_autoprecomp=false)
+        API.add(string.(available_pkgs); allow_autoprecomp = false)
     elseif lower_resp in ["o"]
         editable_envs = filter(v -> v != "@stdlib", LOAD_PATH)
         option_list = String[]
@@ -280,16 +282,16 @@ function try_prompt_pkg_add(pkgs::Vector{Symbol})
             push!(keybindings, only("$n"))
             push!(shown_envs, expanded_env)
         end
-        menu = TerminalMenus.RadioMenu(option_list, keybindings=keybindings, pagesize=length(option_list))
+        menu = TerminalMenus.RadioMenu(option_list, keybindings = keybindings, pagesize = length(option_list))
         default = something(
             # select the first non-default env by default, if possible
             findfirst(!=(Base.active_project()), shown_envs),
             1
         )
         print(ctx.io, "\e[1A\e[1G\e[0J") # go up one line, to the start, and clear it
-        printstyled(ctx.io, " └ "; color=:green)
+        printstyled(ctx.io, " └ "; color = :green)
         choice = try
-            TerminalMenus.request("Select environment:", menu, cursor=default)
+            TerminalMenus.request("Select environment:", menu, cursor = default)
         catch err
             if err isa InterruptException # if ^C is entered
                 println(ctx.io)
@@ -299,7 +301,7 @@ function try_prompt_pkg_add(pkgs::Vector{Symbol})
         end
         choice == -1 && return false
         API.activate(shown_envs[choice]) do
-            API.add(string.(available_pkgs); allow_autoprecomp=false)
+            API.add(string.(available_pkgs); allow_autoprecomp = false)
         end
     elseif (lower_resp in ["n"])
         return false
@@ -315,7 +317,6 @@ function try_prompt_pkg_add(pkgs::Vector{Symbol})
 end
 
 
-
 function __init__()
     if isdefined(Base, :active_repl)
         if Base.active_repl isa REPL.LineEditREPL
@@ -333,7 +334,7 @@ function __init__()
             end
         end
     end
-    if !in(try_prompt_pkg_add, REPL.install_packages_hooks)
+    return if !in(try_prompt_pkg_add, REPL.install_packages_hooks)
         push!(REPL.install_packages_hooks, try_prompt_pkg_add)
     end
 end

ext/REPLExt/compat.jl

@@ -9,12 +9,12 @@ function _compat(ctx::Context; io = nothing)
     compat_str = Operations.get_compat_str(ctx.env.project, "julia")
     push!(opt_strs, Operations.compat_line(io, "julia", nothing, compat_str, longest_dep_len, indent = ""))
     push!(opt_pkgs, "julia")
-    for (dep, uuid) in sort(collect(ctx.env.project.deps); by = x->x.first)
+    for (dep, uuid) in sort(collect(ctx.env.project.deps); by = x -> x.first)
         compat_str = Operations.get_compat_str(ctx.env.project, dep)
         push!(opt_strs, Operations.compat_line(io, dep, uuid, compat_str, longest_dep_len, indent = ""))
         push!(opt_pkgs, dep)
     end
-    menu = TerminalMenus.RadioMenu(opt_strs, pagesize=length(opt_strs))
+    menu = TerminalMenus.RadioMenu(opt_strs, pagesize = length(opt_strs))
     choice = try
         TerminalMenus.request("  Select an entry to edit:", menu)
     catch err
@@ -35,7 +35,7 @@ function _compat(ctx::Context; io = nothing)
         start_pos = length(prompt) + 2
         move_start = "\e[$(start_pos)G"
         clear_to_end = "\e[0J"
-        ccall(:jl_tty_set_mode, Int32, (Ptr{Cvoid},Int32), stdin.handle, true)
+        ccall(:jl_tty_set_mode, Int32, (Ptr{Cvoid}, Int32), stdin.handle, true)
         while true
             print(io, move_start, clear_to_end, buffer, "\e[$(start_pos + cursor)G")
             inp = TerminalMenus._readkey(stdin)
@@ -65,9 +65,9 @@ function _compat(ctx::Context; io = nothing)
                 if cursor == 1
                     buffer = buffer[2:end]
                 elseif cursor == length(buffer)
-                    buffer = buffer[1:end - 1]
+                    buffer = buffer[1:(end - 1)]
                 elseif cursor > 0
-                    buffer = buffer[1:(cursor-1)] * buffer[(cursor + 1):end]
+                    buffer = buffer[1:(cursor - 1)] * buffer[(cursor + 1):end]
                 else
                     continue
                 end
@@ -85,7 +85,7 @@ function _compat(ctx::Context; io = nothing)
         end
         buffer
     finally
-        ccall(:jl_tty_set_mode, Int32, (Ptr{Cvoid},Int32), stdin.handle, false)
+        ccall(:jl_tty_set_mode, Int32, (Ptr{Cvoid}, Int32), stdin.handle, false)
     end
     new_entry = strip(resp)
     compat(ctx, dep, string(new_entry))