Adding an "options" parameter to mini.jump2d's before_start hook

[suy]

Hello!

Thank you all mini contributors. I'm enjoying switching to this plugin's many modules one by one, and retiring some old, mostly unmaintained VimScript code. I'm having a great time!

Here is a humble suggestion that perhaps could help solve mini.jump2d's issue #354 even if partially (and also relates to #355).

I've basically wanted to configure my usage of the plugin like this:

MiniJump2d = require('mini.jump2d')
MiniJump2d.setup(MiniJump2d.builtin_opts.single_character)

-- or with more details
MiniJump2d.setup(vim.tbl_deep_extend('force',
    MiniJump2d.builtin_opts.single_character,
    {
        mappings = { start_jumping = '<Leader>j' },
        labels = 'asdfjkl;ghqwertyuiopzxcvbnm,',
        allowed_windows = { current = true, not_current = false, },
    }
))

Why? Well, on one hand, seemed more "tidy" and logical. On the other, I've seen that the plugin has this on its source:

  H.map('n', keymap, MiniJump2d.start, { desc = 'Start 2d jumping' })
  H.map('x', keymap, MiniJump2d.start, { desc = 'Start 2d jumping' })
  -- Use `<Cmd>...<CR>` to have proper dot-repeat
  -- See https://github.com/neovim/neovim/issues/23406
  -- TODO: use local functions if/when that issue is resolved
  H.map('o', keymap, '<Cmd>lua MiniJump2d.start()<CR>', { desc = 'Start 2d jumping' })

So, mapping all the modes myself seemed a bit worse. I'm not sure also of the nuance of this things, as operator pending mode is usually a thing that scares me a bit. :-)

So, the above configuration doesn't work out of the box, but it does work by applying this small patch:

diff --git i/lua/mini/jump2d.lua w/lua/mini/jump2d.lua
index 633cb11d..6ac0c70d 100644
--- i/lua/mini/jump2d.lua
+++ w/lua/mini/jump2d.lua
@@ -367,7 +367,7 @@ MiniJump2d.start = function(opts)
   local before_start = (opts.hooks or {}).before_start
     or ((vim.b.minijump2d_config or {}).hooks or {}).before_start
     or MiniJump2d.config.hooks.before_start
-  if before_start ~= nil then before_start() end
+  if before_start ~= nil then before_start(opts) end
 
   opts = H.get_config(opts)
   opts.spotter = opts.spotter or MiniJump2d.default_spotter
@@ -667,11 +667,12 @@ local function user_input_opts(input_fun)
     allowed_lines = { blank = false, fold = false },
   }
 
-  local before_start = function()
+  local before_start = function(options)
     local input = input_fun()
     -- Allow user to cancel input and not show any jumping spots
     if input == nil then return end
     res.spotter = MiniJump2d.gen_spotter.pattern(vim.pesc(input))
+    if options then options.spotter = res.spotter end
   end
   res.hooks = { before_start = before_start }
 

I think this should be backwards compatible, as it is just adding a new parameter that did not exist.

Thoughts?

Thanks again!

[echasnovski]

Hi!

The suggested way of having custom ways to jump is to indeed create a mapping and use MiniJump2d.start() directly. As described here.

So, mapping all the modes myself seemed a bit worse.

That's not too bad and can be done relatively concisely. Here is what I am using right now in a wake of improving/rewriting 'mini.jump2d' (see #1818). I am fairly certain that those will be the new defaults ("single_character" variant as a default spotter).

So as there is a rewrite planned, things will (hopefully) be both more configurable and require less configuration to be good :).

---

I'm not sure also of the nuance of this things, as operator pending mode is usually a thing that scares me a bit. :-)

It is not that scary when you get to know it :) It is a mode that activates after you start an operator (action that requires a target), like by pressing d or c or y, etc. This is usually followed by a textobject (like i), a", etc.) or a motion (like t) or e). The 'mini.jump2d' is a jumping plugin, so creating an Operator-pending mode mapping for it would allow to have something like 1) press d; 2) initial the jump; 3) finish the jump -> all the text from the cursor to the jump is deleted.

[suy]

Thank you again. I've indeed seen the discussion on #1818 and others about future changes (I've decided to try jump2d now because of yesterday's post on Reddit, so thanks for chiming in there).

Since you are setting all the 3 modes at one in your config, I'll probably do something like that myself. I thought there was an issue about operator pending mode, given that comment in the source code.

I'm maybe overthinking the whole deal. 🙃

Thank you!

[echasnovski]

I thought there was an issue about operator pending mode, given that comment in the source code.

That code is very old and wasn't changed when it was supposed to. Mostly because "it just works, so don't touch it" :)