(mini.operators) FEATURE: Add config.multiply.func.

Author: echasnovski

doc/mini-operators.txt

@@ -190,6 +190,9 @@ Default values:
     -- Multiply (duplicate) text
     multiply = {
       prefix = 'gm',
+
+      -- Function which can modify text before multiplying
+      func = nil,
     },
 
     -- Replace text with register
@@ -242,6 +245,12 @@ regions are exchanged preserving their indents; if `true` - without them.
 `multiply.prefix` is a string used to automatically infer operator mappings keys
 during |MiniOperators.setup()|. See |MiniOperators-mappings|.
 
+`multiply.func` is a function used to optionally update multiplied text.
+If `nil` (default), text used as is.
+
+Takes content table as input (see "Evaluate" section) and should return
+array of lines as output.
+
 # Replace ~
 
 `replace.prefix` is a string used to automatically infer operator mappings keys

lua/mini/operators.lua

@@ -218,6 +218,12 @@ end
 --- `multiply.prefix` is a string used to automatically infer operator mappings keys
 --- during |MiniOperators.setup()|. See |MiniOperators-mappings|.
 ---
+--- `multiply.func` is a function used to optionally update multiplied text.
+--- If `nil` (default), text used as is.
+---
+--- Takes content table as input (see "Evaluate" section) and should return
+--- array of lines as output.
+---
 --- # Replace ~
 ---
 --- `replace.prefix` is a string used to automatically infer operator mappings keys
@@ -275,6 +281,9 @@ MiniOperators.config = {
   -- Multiply (duplicate) text
   multiply = {
     prefix = 'gm',
+
+    -- Function which can modify text before multiplying
+    func = nil,
   },
 
   -- Replace text with register
@@ -404,6 +413,12 @@ MiniOperators.multiply = function(mode)
     local yank_data = { mark_from = mark_from, mark_to = mark_to, submode = submode, mode = mode, register = 'x' }
     H.do_between_marks('y', yank_data)
 
+    -- Modify lines in "x" register
+    local func = H.get_config().multiply.func or function(content) return content.lines end
+    local x_reginfo = vim.fn.getreginfo('x')
+    x_reginfo.regcontents = func({ lines = x_reginfo.regcontents, submode = submode })
+    vim.fn.setreg('x', x_reginfo)
+
     -- Adjust cursor for a proper paste
     local ref_coords = H.multiply_get_ref_coords(mark_from, mark_to, submode)
     vim.api.nvim_win_set_cursor(0, ref_coords)
@@ -664,6 +679,7 @@ H.setup_config = function(config)
     ['exchange.reindent_linewise'] = { config.exchange.reindent_linewise, 'boolean' },
 
     ['multiply.prefix'] = { config.multiply.prefix, 'string' },
+    ['multiply.func'] = { config.multiply.func, 'function', true },
 
     ['replace.prefix'] = { config.replace.prefix, 'string' },
     ['replace.reindent_linewise'] = { config.replace.reindent_linewise, 'boolean' },

readmes/mini-operators.md

@@ -22,7 +22,7 @@ If you want to help this project grow but don't know where to start, check out [
 
 ## Demo
 
-https://github.com/echasnovski/mini.nvim/assets/24854248/aaa9df18-fe39-4556-89d4-a0591edf31a3
+https://github.com/echasnovski/mini.nvim/assets/24854248/8a3656c4-c92a-4d9f-9711-8d6a751b3e5a
 
 ## Features
 
@@ -178,6 +178,9 @@ Here are code snippets for some common installation methods (use only one):
   -- Multiply (duplicate) text
   multiply = {
     prefix = 'gm',
+
+    -- Function which can modify text before multiplying
+    func = nil,
   },
 
   -- Replace text with register

tests/test_operators.lua

@@ -75,6 +75,9 @@ T['setup()']['creates `config` field'] = function()
   expect_config('exchange.prefix', 'gx')
   expect_config('exchange.reindent_linewise', true)
 
+  expect_config('multiply.prefix', 'gm')
+  expect_config('multiply.func', vim.NIL)
+
   expect_config('replace.prefix', 'gr')
   expect_config('replace.reindent_linewise', true)
 
@@ -103,6 +106,10 @@ T['setup()']['validates `config` argument'] = function()
   expect_config_error({ exchange = { prefix = 1 } }, 'exchange.prefix', 'string')
   expect_config_error({ exchange = { reindent_linewise = 'a' } }, 'exchange.reindent_linewise', 'boolean')
 
+  expect_config_error({ multiply = 'a' }, 'multiply', 'table')
+  expect_config_error({ multiply = { prefix = 1 } }, 'multiply.prefix', 'string')
+  expect_config_error({ multiply = { func = 'a' } }, 'multiply.func', 'function')
+
   expect_config_error({ replace = 'a' }, 'replace', 'table')
   expect_config_error({ replace = { prefix = 1 } }, 'replace.prefix', 'string')
   expect_config_error({ replace = { reindent_linewise = 'a' } }, 'replace.reindent_linewise', 'boolean')
@@ -1286,6 +1293,20 @@ T['Multiply']['works in edge cases'] = function()
   validate_edit({ 'aa', 'bb' }, { 2, 0 }, { 'gm_' }, { 'aa', 'bb', 'bb' }, { 3, 0 })
 end
 
+T['Multiply']['respects `config.multiply.func`'] = function()
+  -- Indent by two spaces only for linewise content
+  child.lua([[MiniOperators.config.multiply.func = function(content)
+    if content.submode ~= 'V' then return content.lines end
+    return vim.tbl_map(function(l) return '  ' .. l end, content.lines)
+  end]])
+
+  validate_edit1d('aa bb', 0, { 'gmiw' }, 'aaaa bb', 2)
+  validate_edit({ 'aa', 'bb', '', 'cc' }, { 1, 0 }, { 'gmip' }, { 'aa', 'bb', '  aa', '  bb', '', 'cc' }, { 3, 2 })
+
+  if child.fn.has('nvim-0.9') == 0 then MiniTest.skip('Blockwise selection has core issues on Neovim<0.9.') end
+  validate_edit({ 'ab', 'cd' }, { 1, 0 }, { '<C-v>j', 'gm' }, { 'aab', 'ccd' }, { 1, 1 })
+end
+
 T['Multiply']["works with 'y' in 'cpoptions'"] = function()
   child.cmd('set cpoptions+=y')
 
@@ -1422,6 +1443,17 @@ T['Multiply']['respects `vim.{g,b}.minioperators_disable`'] = new_set({
   end,
 })
 
+T['Multiply']['respects `vim.b.minioperators_config`'] = function()
+  -- Indent by two spaces
+  child.lua([[_G.multiply_func = function(content)
+    return vim.tbl_map(function(l) return '  ' .. l end, content.lines)
+  end
+  vim.b.minioperators_config = { multiply = { func = _G.multiply_func } }
+  ]])
+
+  validate_edit({ 'aa', 'bb', '', 'cc' }, { 1, 0 }, { 'gmip' }, { 'aa', 'bb', '  aa', '  bb', '', 'cc' }, { 3, 2 })
+end
+
 T['Replace'] = new_set()
 
 T['Replace']['works charwise in Normal mode'] = function()