create uri utilities

Author: aviatesk

src/completions.jl

@@ -145,19 +145,14 @@ completionurl(c::REPLCompletions.ModuleCompletion) = begin
   mod, name = c.parent, c.mod
   val = getfield′(mod, name)
   if val isa Module # module info
-    parentmodule(val) == val || val ∈ (Main, Base, Core) ?
-      "atom://julia-client/?moduleinfo=true&mod=$(name)" :
-      "atom://julia-client/?moduleinfo=true&mod=$(mod).$(name)"
+    urimoduleinfo(parentmodule(val) == val || val ∈ (Base, Core) ? name : "$mod.$name")
   else
-    "atom://julia-client/?docs=true&mod=$(mod)&word=$(name)"
+    uridocs(mod, name)
   end
 end
-completionurl(c::REPLCompletions.MethodCompletion) =
-  "atom://julia-client/?docs=true&mod=$(c.method.module)&word=$(c.method.name)"
-completionurl(c::REPLCompletions.PackageCompletion) =
-  "atom://julia-client/?moduleinfo=true&mod=$(c.package)"
-completionurl(c::REPLCompletions.KeywordCompletion) =
-  "atom://julia-client/?docs=true&mod=Main&word=$(c.keyword)"
+completionurl(c::REPLCompletions.MethodCompletion) = uridocs(c.method.module, c.method.name)
+completionurl(c::REPLCompletions.PackageCompletion) = urimoduleinfo(c.package)
+completionurl(c::REPLCompletions.KeywordCompletion) = uridocs("Main", c.keyword)
 
 completionmodule(mod, c) = shortstr(mod)
 completionmodule(mod, c::REPLCompletions.ModuleCompletion) = shortstr(c.parent)

src/refactor.jl

@@ -23,9 +23,9 @@ function renamerefactor(
   mod = getmodule(mod)
 
   # catch field renaming
-  modulenote = if (obj = first(split(full, '.'))) != old
+  modnote = if (obj = first(split(full, '.'))) != old
     if (parentmod = getfield′(mod, obj)) isa Module && parentmod != mod
-      "**NOTE**: `$old` is defined in `$parentmod` -- you may need the same rename refactorings in that module as well."
+      modulenote(old, parentmod)
     else
       return Dict(:warning => "Rename refactoring on a field isn't available: `$obj.$old`")
     end
@@ -53,15 +53,14 @@ function renamerefactor(
     if val isa Undefined && Symbol(old) in keys(Docs.keywords)
       return Dict(:warning => "Keywords can't be renamed: `$old`")
     end
-    # update modulenote
-    if isempty(modulenote) && applicable(parentmodule, val) && (parentmod = parentmodule(val)) != mod
-      modulenote =
-        "**NOTE**: `$old` is defined in `$parentmod` -- you may need the same rename refactorings in that module as well."
+    # update modnote
+    if isempty(modnote) && applicable(parentmodule, val) && (parentmod = parentmodule(val)) != mod
+      modnote = modulenote(old, parentmod)
     end
     kind, desc = globalrefactor(old, new, mod)
     return Dict(
       kind => kind === :success ?
-        join(("_Global_ rename refactoring `$old` ⟹ `$new` succeeded.", modulenote, desc), "\n\n") :
+        join(("_Global_ rename refactoring `$old` ⟹ `$new` succeeded.", modnote, desc), "\n\n") :
         desc
     )
   catch err
@@ -71,6 +70,9 @@ function renamerefactor(
   return Dict(:error => "Rename refactoring `$old` ⟹ `$new` failed")
 end
 
+modulenote(old, parentmod) =
+  "**NOTE**: `$old` is defined in `$parentmod` -- you may need the same rename refactorings in that module as well."
+
 # local refactor
 # --------------
 
@@ -127,9 +129,9 @@ function refactorfiles(old, new, mod, files)
   @info "Finish global rename refactoring" progress=1 _id=id
 
   return if !isempty(refactoredfiles)
-    filelist = ("- [$file](atom://julia-client/?open=true&file=$(file)&line=0)" for file in refactoredfiles)
+    filelist = ("- [$file]($(uriopen(file)))" for file in refactoredfiles)
     (:success, string("Refactored files (all in `$mod` module):\n\n", join(filelist, '\n')))
   else
-    (:warning, "No rename refactoring occured on `$old`")
+    (:warning, "No rename refactoring occured on `$old` in `$mod` module.")
   end
 end

src/utils.jl

@@ -185,6 +185,13 @@ cangetdocs(mod::Module, word::Symbol) =
 cangetdocs(mod::Module, word::AbstractString) = cangetdocs(mod, Symbol(word))
 cangetdocs(mod::AbstractString, word::Union{Symbol, AbstractString}) = cangetdocs(getmodule(mod), word)
 
+# uri utilties
+# ------------
+
+uriopen(file, line = 0) = "atom://julia-client/?open=true&file=$(file)&line=$(line)"
+uridocs(mod, word) = "atom://julia-client/?docs=true&mod=$(mod)&word=$(word)"
+urimoduleinfo(mod) = "atom://julia-client/?moduleinfo=true&mod=$(mod)"
+
 #=
 module file detections