[mini.jump] Improve highlighting after jumping in Operator-pending mode

[abeldekat]

Contributing guidelines

• I have read CONTRIBUTING.md
• I have read CODE_OF_CONDUCT.md

Module(s)

mini.jump

Description

This feature request is based on this comment

-- edited --

Scenario with file containing a single word:

mark

• Open file, position cursor on the 'a'
• Type dfm
• Notice that text is not modified, as expected
• Notice that m is not highlighted

Notably, highlighting does work as expected using the same scenario with different file contents: Empty first line, mark is on the second with cursor on its a

[abeldekat]

@echasnovski, after all the autocommands you considered on my behalf, I have another solution...)

This restores highlighting in both directions for the given scenario. All tests pass.

diff --git a/lua/mini/jump.lua b/lua/mini/jump.lua
index 1f9b3f37..597a6859 100644
--- a/lua/mini/jump.lua
+++ b/lua/mini/jump.lua
@@ -232,7 +232,12 @@ MiniJump.jump = function(target, backward, till, n_times)
 
   -- Ensure to undo "consume a character" effect in Operator-pending expression
   -- mapping if there is no target found. Do it here to also act on dot-repeat.
-  if is_expr and not has_jumped then vim.schedule(function() vim.cmd('undo!') end) end
+  if is_expr and not has_jumped then
+    vim.schedule(function()
+      H.cache.is_operator_pending_undo = true
+      vim.cmd('undo!')
+    end)
+  end
 end
 
 --- Make smart jump
@@ -301,6 +306,9 @@ H.cache = {
   -- Latest cursor position data
   latest_cursor = nil,
 
+  -- The undo command prevented a character to be consumed
+  is_operator_pending_undo = false,
+
   -- Whether helper message was shown
   msg_shown = false,
 }
@@ -411,11 +419,17 @@ end
 -- Autocommands ---------------------------------------------------------------
 H.on_cursormoved = function()
   -- Check if jumping to avoid unnecessary actions on every CursorMoved
-  if MiniJump.state.jumping then
-    H.cache.n_cursor_moved = H.cache.n_cursor_moved + 1
-    -- Stop jumping only if `CursorMoved` was not a result of smart jump
-    if H.cache.n_cursor_moved > 1 then MiniJump.stop_jumping() end
+  if not MiniJump.state.jumping then return end
+
+  -- Ignore CursorMoved when jump() used the undo command
+  if H.cache.is_operator_pending_undo then
+    H.cache.is_operator_pending_undo = false
+    return
   end
+
+  H.cache.n_cursor_moved = H.cache.n_cursor_moved + 1
+  -- Stop jumping only if `CursorMoved` was not a result of smart jump
+  if H.cache.n_cursor_moved > 1 then MiniJump.stop_jumping() end
 end
 
 H.stop_if_curbuf = function(ev)

[echasnovski]

This restores highlighting in both directions for the given scenario. All tests pass.

This feels better, although still relies on the fact that "consuming character" will trigger CursorMoved.

I'd like to spend again some more time to maybe find a fundamentally better approach than the one that require undo!. Because there are other issues with it which you haven't found yet :) Like when doing dfm on an empty line.