better messaging & suppress field renaming

Author: aviatesk

src/refactor.jl

@@ -1,6 +1,7 @@
-handle("refactor") do data
+handle("renamerefactor") do data
   @destruct [
     old,
+    full,
     new,
     path,
     # local context
@@ -11,35 +12,48 @@ handle("refactor") do data
     # module context
     mod || "Main",
   ] = data
-  refactor(old, new, path, column, row, startRow, context, mod)
+  renamerefactor(old, full, new, path, column, row, startRow, context, mod)
 end
 
-function refactor(
-  old, new, path,
+function renamerefactor(
+  old, full, new, path,
   column = 1, row = 1, startrow = 0, context = "",
   mod = "Main",
 )
+  mod = getmodule(mod)
+
+  # catch field renaming
+  if (obj = first(split(full, '.'))) != old && !isa(getfield′(mod, obj), Module)
+    return Dict(:warning => "Rename refactoring on a field isn't available: `$obj.$old`")
+  end
+
   # local refactor only if `old` is really a local binding
   bind = CSTParser.bindingof(CSTParser.parse(context))
   if bind === nothing || old != bind.name
     try
       refactored = localrefactor(old, new, path, column, row, startrow, context)
-      isempty(refactored) || return Dict(:text => refactored)
+      isempty(refactored) || return Dict(
+        :text    => refactored,
+        :success => "Local rename refactoring `$old` ⟹ `$new` succeeded"
+      )
     catch err
       @error err
     end
   end
 
   try
-    mod = getmodule(mod)
     val = getfield′(mod, old)
-    result = globalrefactor(old, new, mod, val)
-    return result isa String ? Dict(:error => result) : Dict(:error => false)
+    kind, description = globalrefactor(old, new, mod, val)
+    return Dict(
+      kind     => description,
+      :success => kind !== :info ? false :
+        "Global rename refactoring `$old` ⟹ `$new` succeeded"
+    )
   catch err
     @error err
   end
 
-  return Dict(:error => "Rename refactoring failed: `$old` -> `$new`")
+  return Dict(:error => "Rename refactoring `$old` ⟹ `$new` failed")
 end
 
 # local refactor
@@ -63,7 +77,7 @@ end
 globalrefactor(old, new, mod, @nospecialize(val)) = _globalrefactor(old, new, mod) # general case
 function globalrefactor(old, new, mod, val::Undefined)
   Symbol(old) in keys(Docs.keywords) ?
-    "Keywords can't be renamed: `$old`" :
+    (:warning, "Keywords can't be renamed: `$old`") :
     _globalrefactor(old, new, mod)
 end
 
@@ -76,30 +90,31 @@ function _globalrefactor(old, new, mod)
   end
 end
 
-function refactorfiles(old, new, obj, files)
+function refactorfiles(old, new, mod, files)
   id = "global_rename_refactor_progress"
   @info "Start global rename refactoring" progress=0 _id=id
 
-  oldsym     = Symbol(old)
-  newsym     = Symbol(new)
-  modulesyms = Set(Symbol.(Base.loaded_modules_array()))
-  total      = length(files)
+  oldsym = Symbol(old)
+  newsym = Symbol(new)
+  total  = length(files)
+
+  desc = ""
 
   for (i, file) ∈ enumerate(files)
     @info "Refactoring: $file ($i / $total)" progress=i/total _id=id
     MacroTools.sourcewalk(file) do ex
       return if ex === oldsym
         newsym
-      elseif @capture(ex, obj_.$oldsym)
-        if obj in modulesyms
-          @warn "Came across a global rename refactoring across different modules: `$obj.$old` -> `$obj.$new`"
-        end
-        Expr(:., obj, newsym)
+      elseif @capture(ex, m_.$oldsym) && getfield′(mod, m) isa Module
+        desc *= "`$m.$old` ⟹ `$m.$new` in $(fullpath(file))\n"
+        Expr(:., m, newsym)
       else
         ex
       end
     end
   end
 
   @info "Finish global rename refactoring" progress=1 _id=id
+
+  (:info, isempty(desc) ? "" : "Refactorings across modules\n\n" * desc)
 end