Skip to content

Remove LibGit2 dep #167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,14 @@ name = "DocStringExtensions"
uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
version = "0.9.3"

[deps]
LibGit2 = "76f85450-5226-5b5a-8eaa-529ad045b433"

[compat]
julia = "1"

[extras]
LibGit2 = "76f85450-5226-5b5a-8eaa-529ad045b433"
Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

[targets]
test = ["Markdown", "Pkg", "Test"]
test = ["LibGit2", "Markdown", "Pkg", "Test"]
1 change: 0 additions & 1 deletion src/DocStringExtensions.jl
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ module DocStringExtensions

# Imports.

import LibGit2

# Exports.

Expand Down
51 changes: 8 additions & 43 deletions src/utilities.jl
Original file line number Diff line number Diff line change
Expand Up @@ -517,51 +517,16 @@ end
"""
$(:SIGNATURES)

Get the URL (file and line number) where a method `m` is defined.
Get the URL (file and line number) where a method `m` is defined. May return an empty string
if the URL can not be determined.

Note that this is based on the implementation of `Base.url`, but handles URLs correctly
on TravisCI as well.
Requires the `LibGit2` to be present in the environment.
"""
url(m::Method) = url(m.module, string(m.file), m.line)

function url(mod::Module, file::AbstractString, line::Integer)
file = Sys.iswindows() ? replace(file, '\\' => '/') : file
if Base.inbase(mod) && !isabspath(file)
local base = "https://github.com/JuliaLang/julia/tree"
if isempty(Base.GIT_VERSION_INFO.commit)
return "$base/v$VERSION/base/$file#L$line"
else
local commit = Base.GIT_VERSION_INFO.commit
return "$base/$commit/base/$file#L$line"
end
else
if isfile(file)
local d = dirname(file)
try # might not be in a git repo
LibGit2.with(LibGit2.GitRepoExt(d)) do repo
LibGit2.with(LibGit2.GitConfig(repo)) do cfg
local u = LibGit2.get(cfg, "remote.origin.url", "")
local m = match(LibGit2.GITHUB_REGEX, u)
u = m === nothing ? get(ENV, "TRAVIS_REPO_SLUG", "") : m.captures[1]
local commit = string(LibGit2.head_oid(repo))
local root = LibGit2.path(repo)
if startswith(file, root) || startswith(realpath(file), root)
local base = "https://github.com/$u/tree"
local filename = file[(length(root) + 1):end]
return "$base/$commit/$filename#L$line"
else
return ""
end
end
end
catch err
isa(err, LibGit2.GitError) || rethrow()
return ""
end
else
return ""
end
end
function url(m::Method)
# Base.url() something produces file:// URLs, but we want these to be sharable web URLs.
# So we just say we couldn't determine the URL if we get one of those.
url = Base.url(m)
return startswith(url, "file://") ? "" : url
end

# This is compat to make sure that we have ismutabletype available pre-1.7.
Expand Down
Loading