fix preview of generate so it does not create any files (#330)

JuliaLang · Jun 5, 2018 · 15e410e · 15e410e
1 parent f82cd24
commit 15e410e
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 10 deletions.
diff --git a/stdlib/Pkg/src/REPLMode.jl b/stdlib/Pkg/src/REPLMode.jl
@@ -748,7 +748,7 @@ function do_generate!(ctx::Context, tokens::Vector{Token})
             cmderror("`generate` takes a name of the project to create")
         end
     end
-    API.generate(pkg)
+    API.generate(ctx, pkg)
 end
 
 function do_precompile!(ctx::Context, tokens::Vector{Token})

diff --git a/stdlib/Pkg/src/generate.jl b/stdlib/Pkg/src/generate.jl
@@ -1,24 +1,29 @@
 # This file is a part of Julia. License is MIT: https://julialang.org/license
 
-function generate(path::String)
+generate(path::String; kwargs...) = generate(Context(), path; kwargs...)
+function generate(ctx::Context, path::String; kwargs...)
+    Context!(ctx; kwargs...)
+    ctx.preview && preview_info()
     dir, pkg = dirname(path), basename(path)
     isdir(path) && cmderror("$(abspath(path)) already exists")
     printstyled("Generating"; color=:green, bold=true)
     print(" project $pkg:\n")
-    project(pkg, dir)
-    entrypoint(pkg, dir)
+    project(pkg, dir; preview=ctx.preview)
+    entrypoint(pkg, dir; preview=ctx.preview)
+    ctx.preview && preview_info()
     return
 end
 
-function genfile(f::Function, pkg::String, dir::String, file::String)
+function genfile(f::Function, pkg::String, dir::String, file::String; preview::Bool)
     path = joinpath(dir, pkg, file)
     println(stdout, "    $path")
+    preview && return
     mkpath(dirname(path))
     open(f, path, "w")
     return
 end
 
-function project(pkg::String, dir::String)
+function project(pkg::String, dir::String; preview::Bool)
     name = email = nothing
     gitname = LibGit2.getconfig("user.name", "")
     isempty(gitname) || (name = gitname)
@@ -46,7 +51,7 @@ function project(pkg::String, dir::String)
 
     authorstr = "[\"$name " * (email == nothing ? "" : "<$email>") * "\"]"
 
-    genfile(pkg, dir, "Project.toml") do io
+    genfile(pkg, dir, "Project.toml"; preview=preview) do io
         print(io,
             """
             authors = $authorstr
@@ -60,8 +65,8 @@ function project(pkg::String, dir::String)
     end
 end
 
-function entrypoint(pkg::String, dir)
-    genfile(pkg, dir, "src/$pkg.jl") do io
+function entrypoint(pkg::String, dir; preview::Bool)
+    genfile(pkg, dir, "src/$pkg.jl"; preview=preview) do io
         print(io,
            """
             module $pkg

diff --git a/stdlib/Pkg/test/pkg.jl b/stdlib/Pkg/test/pkg.jl
@@ -214,11 +214,19 @@ temp_pkg_dir() do project_path
     end
 end
 
-
 @testset "parse package url win" begin
     @test typeof(Pkg.REPLMode.parse_package("https://github.com/abc/ABC.jl"; context=Pkg.REPLMode.CMD_ADD)) == PackageSpec
 end
 
+@testset "preview generate" begin
+    mktempdir() do tmp
+        cd(tmp) do
+            Pkg.generate("Foo"; preview=true)
+            @test !isdir(joinpath(tmp, "Foo"))
+        end
+    end
+end
+
 include("repl.jl")
 
 end # module