Merge pull request #7 from timholy/teh/printing

Don't export PkgFiles and improve printing

Author: timholy

src/CodeTracking.jl

@@ -4,7 +4,6 @@ using Base: PkgId
 using Core: LineInfoNode
 using UUIDs
 
-export PkgFiles
 export whereis, definition, pkgfiles
 
 include("pkgfiles.jl")
@@ -97,8 +96,8 @@ definition(method::Method) = definition(method, Expr)
     info = pkgfiles(name::AbstractString)
     info = pkgfiles(name::AbstractString, uuid::UUID)
 
-Return a [`PkgFiles`](@ref) structure with information about the files that define the package
-specified by `name` and `uuid`.
+Return a [`CodeTracking.PkgFiles`](@ref) structure with information about the files that
+define the package specified by `name` and `uuid`.
 Returns `nothing` if this package has not been loaded.
 """
 pkgfiles(name::AbstractString, uuid::UUID) = pkgfiles(PkgId(uuid, name))
@@ -113,8 +112,8 @@ pkgfiles(id::PkgId) = get(_pkgfiles, id, nothing)
 """
     info = pkgfiles(mod::Module)
 
-Return a [`PkgFiles`](@ref) structure with information about the files that were loaded to
-define the package that defined `mod`.
+Return a [`CodeTracking.PkgFiles`](@ref) structure with information about the files that
+were loaded to define the package that defined `mod`.
 """
 pkgfiles(mod::Module) = pkgfiles(PkgId(mod))
 

src/pkgfiles.jl

@@ -25,8 +25,15 @@ srcfiles(info::PkgFiles) = info.files
 basedir(info::PkgFiles) = info.basedir
 
 function Base.show(io::IO, info::PkgFiles)
-    println(io, "PkgFiles(", info.id, "):")
-    println(io, "  basedir: \"", info.basedir, '"')
-    print(io, "  files: ")
-    show(io, info.files)
+    compact = get(io, :compact, false)
+    if compact
+        print(io, "PkgFiles(", info.id.name, ", ", info.basedir, ", ")
+        show(io, info.files)
+        print(io, ')')
+    else
+        println(io, "PkgFiles(", info.id, "):")
+        println(io, "  basedir: \"", info.basedir, '"')
+        print(io, "  files: ")
+        show(io, info.files)
+    end
 end

test/runtests.jl

@@ -1,6 +1,6 @@
 using CodeTracking
 using Test
-# Note: ColorTypes needs to be installed, but note the absence of `using`
+# Note: ColorTypes needs to be installed, but note the intentional absence of `using ColorTypes`
 
 include("script.jl")
 
@@ -21,7 +21,7 @@ include("script.jl")
     f2(x, y) = x + y
     """
 
-    info = PkgFiles(Base.PkgId(CodeTracking))
+    info = CodeTracking.PkgFiles(Base.PkgId(CodeTracking))
     @test Base.PkgId(info) === info.id
     @test CodeTracking.basedir(info) == dirname(@__DIR__)