add Pkg.precompile(f) do for delayed precompilation

Author: IanButterworth

src/API.jl

@@ -1176,6 +1176,13 @@ function precompile(ctx::Context, pkgs::Vector{PackageSpec}; internal_call::Bool
     end
 end
 
+function precompile(f, args...; kwargs...)
+    Base.ScopedValues.@with _autoprecompilation_enabled_scoped => false begin
+        f()
+        Pkg.precompile(args...; kwargs...)
+    end
+end
+
 function tree_hash(repo::LibGit2.GitRepo, tree_hash::String)
     try
         return LibGit2.GitObject(repo, tree_hash)

src/Pkg.jl

@@ -65,7 +65,7 @@ usable_io(io) = (io isa Base.TTY) || (io isa IOContext{IO} && io.io isa Base.TTY
 can_fancyprint(io::IO) = (usable_io(io)) && (get(ENV, "CI", nothing) != "true")
 
 _autoprecompilation_enabled::Bool = true
-_autoprecompilation_enabled_scoped = ScopedValue{Bool}(true)
+_autoprecompilation_enabled_scoped = Base.ScopedValues.ScopedValue{Bool}(true)
 autoprecompilation_enabled(state::Bool) = (autoprecompilation_enabled = state)
 function should_autoprecompile()
     if Base.JLOptions().use_compiled_modules == 1 &&
@@ -204,11 +204,21 @@ const add = API.add
     Pkg.precompile(; strict::Bool=false, timing::Bool=false)
     Pkg.precompile(pkg; strict::Bool=false, timing::Bool=false)
     Pkg.precompile(pkgs; strict::Bool=false, timing::Bool=false)
+    Pkg.precompile(f, args...; kwargs...)
 
 Precompile all or specific dependencies of the project in parallel.
 
 Set `timing=true` to show the duration of the precompilation of each dependency.
 
+To delay autoprecompilation of multiple Pkg actions until the end use.
+This may be most efficient while manipulating the environment in various ways.
+
+```julia
+Pkg.precompile() do
+    # Pkg actions here
+end
+```
+
 !!! note
     Errors will only throw when precompiling the top-level dependencies, given that
     not all manifest dependencies may be loaded by the top-level dependencies on the given system.