Merge #24

24: Don’t export `@git_cmd` - remove `@git_cmd` from the public API r=DilumAluthge a=DilumAluthge



Co-authored-by: Dilum Aluthge <dilum@aluthge.com>

Author: bcbi-bot

Project.toml

@@ -1,7 +1,7 @@
 name = "GitCommand"
 uuid = "49b5b516-ca3f-4003-a081-42bdcf55082d"
 authors = ["Dilum Aluthge", "Brown Center for Biomedical Informatics"]
-version = "0.1.2"
+version = "0.2.0"
 
 [deps]
 Git_jll = "f8c6e375-362e-5223-8a59-34ff63f689eb"

README.md

@@ -25,9 +25,3 @@ git() do git
     run(`$git clone https://github.com/JuliaRegistries/General`)
 end
 ```
-
-```julia
-using GitCommand
-
-run(git`clone https://github.com/JuliaRegistries/General`)
-```

src/GitCommand.jl

@@ -3,10 +3,11 @@ module GitCommand
 import Git_jll
 
 export git
-export @git_cmd
+# export @git_cmd
 
 include("env_mapping.jl")
 include("git_cmd.jl")
+include("nonpublic.jl")
 include("public.jl")
 include("util.jl")
 

src/nonpublic.jl

@@ -0,0 +1,3 @@
+macro git_cmd(ex)
+    return _git_cmd(ex)
+end

src/public.jl

@@ -1,7 +1,3 @@
-macro git_cmd(ex)
-    return _git_cmd(ex)
-end
-
 function git(f::Function;
              adjust_PATH::Bool = true,
              adjust_LIBPATH::Bool = true)

test/runtests.jl

@@ -30,7 +30,7 @@ end
     with_temp_dir() do tmp_dir
         @test !isdir("General")
         @test !isfile(joinpath("General", "Registry.toml"))
-        cmd = git`clone https://github.com/JuliaRegistries/General`
+        cmd = GitCommand.git`clone https://github.com/JuliaRegistries/General`
         @test cmd isa Cmd
         run(cmd)
         @test isdir("General")