feat(surround)!: stop creating update_n_lines mapping

Details:
- It occupies `sn` "mapping real estate" (for which there are future
  plans).
- It is rarely needed during runtime. But if it is, it is
  straightforward to create manually with present `update_n_lines()`
  function.

Author: echasnovski

CHANGELOG.md

@@ -133,6 +133,10 @@ There are following change types:
 
 ## mini.surround
 
+### Evolve
+
+- Stop creating `update_n_lines` mapping: it occupies "mapping real estate" while being rarely needed and straightforward to create manually using `MiniSurround.update_n_lines()`.
+
 ### Refine
 
 - Update `gen_spec.inpuf.treesitter()` to have `use_nvim_treesitter = false` as default option value (instead of `true`). It used to implement more advanced behavior, but as built-in `vim.treesitter` is capable enough, there is no need in extra dependency. The option will be removed after the release.

doc/mini-surround.txt

@@ -16,7 +16,6 @@ Features:
     - Replace surrounding with `sr`.
     - Find surrounding with `sf` or `sF` (move cursor right or left).
     - Highlight surrounding with `sh`.
-    - Change number of neighbor lines with `sn` (see |MiniSurround-algorithm|).
 
 - Surrounding is identified by a single character as both "input" (in
   `delete` and `replace` start, `find`, and `highlight`) and "output" (in
@@ -507,7 +506,6 @@ Default values:
       find_left = 'sF', -- Find surrounding (to the left)
       highlight = 'sh', -- Highlight surrounding
       replace = 'sr', -- Replace surrounding
-      update_n_lines = 'sn', -- Update `n_lines`
 
       suffix_last = 'l', -- Suffix to search with "prev" method
       suffix_next = 'n', -- Suffix to search with "next" method
@@ -547,7 +545,6 @@ behavior closest to 'tpope/vim-surround' (but not identical), use this setup: >l
       find_left = '',
       highlight = '',
       replace = 'cs',
-      update_n_lines = '',
 
       -- Add this only if you don't want to use extended mappings
       suffix_last = '',
@@ -746,11 +743,12 @@ No need to use it directly, everything is setup in |MiniSurround.setup|.
 ------------------------------------------------------------------------------
                                                  *MiniSurround.update_n_lines()*
                         `MiniSurround.update_n_lines`()
-Update `MiniSurround.config.n_lines`
+Update `MiniSurround.config.n_lines` from user input
 
-Convenient wrapper for updating `MiniSurround.config.n_lines` in case the
-default one is not appropriate.
+Mapping example: >lua
 
+  vim.keymap.set('n', 'sn', '<Cmd>lua MiniSurround.update_n_lines()<CR>')
+<
 ------------------------------------------------------------------------------
                                                      *MiniSurround.user_input()*
                   `MiniSurround.user_input`({prompt}, {text})

lua/mini/surround.lua

@@ -16,7 +16,6 @@
 ---     - Replace surrounding with `sr`.
 ---     - Find surrounding with `sf` or `sF` (move cursor right or left).
 ---     - Highlight surrounding with `sh`.
----     - Change number of neighbor lines with `sn` (see |MiniSurround-algorithm|).
 ---
 --- - Surrounding is identified by a single character as both "input" (in
 ---   `delete` and `replace` start, `find`, and `highlight`) and "output" (in
@@ -514,7 +513,6 @@ end
 ---       find_left = '',
 ---       highlight = '',
 ---       replace = 'cs',
----       update_n_lines = '',
 ---
 ---       -- Add this only if you don't want to use extended mappings
 ---       suffix_last = '',
@@ -687,7 +685,6 @@ MiniSurround.config = {
     find_left = 'sF', -- Find surrounding (to the left)
     highlight = 'sh', -- Highlight surrounding
     replace = 'sr', -- Replace surrounding
-    update_n_lines = 'sn', -- Update `n_lines`
 
     suffix_last = 'l', -- Suffix to search with "prev" method
     suffix_next = 'n', -- Suffix to search with "next" method
@@ -894,16 +891,15 @@ MiniSurround.highlight = function()
   end, config.highlight_duration)
 end
 
---- Update `MiniSurround.config.n_lines`
+--- Update `MiniSurround.config.n_lines` from user input
 ---
---- Convenient wrapper for updating `MiniSurround.config.n_lines` in case the
---- default one is not appropriate.
+--- Mapping example: >lua
+---
+---   vim.keymap.set('n', 'sn', '<Cmd>lua MiniSurround.update_n_lines()<CR>')
+--- <
 MiniSurround.update_n_lines = function()
-  if H.is_disabled() then return '<Esc>' end
-
   local n_lines = MiniSurround.user_input('New number of neighbor lines', MiniSurround.config.n_lines)
-  n_lines = math.floor(tonumber(n_lines) or MiniSurround.config.n_lines)
-  MiniSurround.config.n_lines = n_lines
+  MiniSurround.config.n_lines = math.floor(tonumber(n_lines) or MiniSurround.config.n_lines)
 end
 
 --- Ask user for input
@@ -1173,7 +1169,6 @@ H.setup_config = function(config)
   H.check_type('mappings.find_left', config.mappings.find_left, 'string')
   H.check_type('mappings.highlight', config.mappings.highlight, 'string')
   H.check_type('mappings.replace', config.mappings.replace, 'string')
-  H.check_type('mappings.update_n_lines', config.mappings.update_n_lines, 'string')
 
   H.check_type('mappings.suffix_last', config.mappings.suffix_last, 'string')
   H.check_type('mappings.suffix_next', config.mappings.suffix_next, 'string')
@@ -1199,7 +1194,6 @@ H.apply_config = function(config)
   map(m.find_left, H.make_action('find', 'left'),  'Find left surrounding')
   map(m.highlight, H.make_action('highlight'),     'Highlight surrounding')
 
-  H.map('n', m.update_n_lines, MiniSurround.update_n_lines, { desc = 'Update `MiniSurround.config.n_lines`' })
   H.map('x', m.add, [[:<C-u>lua MiniSurround.add('visual')<CR>]], { desc = 'Add surrounding to selection' })
 
   -- Make extended mappings

readmes/mini-surround.md

@@ -36,7 +36,6 @@ https://github.com/user-attachments/assets/e91b6e16-7a9c-44aa-afb4-7e07efc3e811
     - Replace surrounding with `sr`.
     - Find surrounding with `sf` or `sF` (move cursor right or left).
     - Highlight surrounding with `sh`.
-    - Change number of neighbor lines with `sn` (see `:h MiniSurround-algorithm`).
 - Surrounding is identified by a single character as both "input" (in `delete` and `replace` start, `find`, and `highlight`) and "output" (in `add` and `replace` end):
     - 'f' - function call (string of alphanumeric symbols or '_' or '.' followed by balanced '()'). In "input" finds function call, in "output" prompts user to enter function name.
     - 't' - tag. In "input" finds tag with same identifier, in "output" prompts user to enter tag name.
@@ -166,7 +165,6 @@ Here are code snippets for some common installation methods (use only one):
     find_left = 'sF', -- Find surrounding (to the left)
     highlight = 'sh', -- Highlight surrounding
     replace = 'sr', -- Replace surrounding
-    update_n_lines = 'sn', -- Update `n_lines`
 
     suffix_last = 'l', -- Suffix to search with "prev" method
     suffix_next = 'n', -- Suffix to search with "next" method

tests/test_surround.lua

@@ -122,7 +122,6 @@ T['setup()']['creates `config` field'] = function()
   expect_config('mappings.find_left', 'sF')
   expect_config('mappings.highlight', 'sh')
   expect_config('mappings.replace', 'sr')
-  expect_config('mappings.update_n_lines', 'sn')
   expect_config('mappings.suffix_last', 'l')
   expect_config('mappings.suffix_next', 'n')
   expect_config('respect_selection_type', false)
@@ -153,7 +152,6 @@ T['setup()']['validates `config` argument'] = function()
   expect_config_error({ mappings = { find_left = 1 } }, 'mappings.find_left', 'string')
   expect_config_error({ mappings = { highlight = 1 } }, 'mappings.highlight', 'string')
   expect_config_error({ mappings = { replace = 1 } }, 'mappings.replace', 'string')
-  expect_config_error({ mappings = { update_n_lines = 1 } }, 'mappings.update_n_lines', 'string')
   expect_config_error({ mappings = { suffix_last = 1 } }, 'mappings.suffix_last', 'string')
   expect_config_error({ mappings = { suffix_next = 1 } }, 'mappings.suffix_next', 'string')
   expect_config_error({ n_lines = 'a' }, 'n_lines', 'number')
@@ -198,6 +196,41 @@ T['setup()']['properly handles `config.mappings`'] = function()
   eq(has_map('srn', 'next'), true)
 end
 
+T['update_n_lines()'] = new_set({
+  hooks = {
+    pre_case = function() child.lua('vim.keymap.set("n", "sn", "<Cmd>lua MiniSurround.update_n_lines()<CR>")') end,
+  },
+})
+
+T['update_n_lines()']['works'] = function()
+  local cur_n_lines = child.lua_get('MiniSurround.config.n_lines')
+
+  -- Should ask for input, display prompt text and current value of `n_lines`
+  type_keys('sn')
+  eq(child.fn.mode(), 'c')
+  eq(child.fn.getcmdline(), tostring(cur_n_lines))
+
+  type_keys('0', '<CR>')
+  eq(child.lua_get('MiniSurround.config.n_lines'), 10 * cur_n_lines)
+end
+
+T['update_n_lines()']['allows cancelling with `<Esc> and <C-c>`'] = function()
+  local validate_cancel = function(key)
+    child.ensure_normal_mode()
+    local cur_n_lines = child.lua_get('MiniSurround.config.n_lines')
+
+    type_keys('sn')
+    eq(child.fn.mode(), 'c')
+
+    type_keys(key)
+    eq(child.fn.mode(), 'n')
+    eq(child.lua_get('MiniSurround.config.n_lines'), cur_n_lines)
+  end
+
+  validate_cancel('<Esc>')
+  validate_cancel('<C-c>')
+end
+
 T['gen_spec'] = new_set()
 
 T['gen_spec']['input'] = new_set()
@@ -1740,57 +1773,6 @@ T['Highlight surrounding']['respects `vim.b.minisurround_config`'] = function()
   child.expect_screenshot({ ignore_attr = { 5 } })
 end
 
-T['Update number of lines'] = new_set()
-
-T['Update number of lines']['works'] = function()
-  local cur_n_lines = child.lua_get('MiniSurround.config.n_lines')
-
-  -- Should ask for input, display prompt text and current value of `n_lines`
-  type_keys('sn')
-  eq(child.fn.mode(), 'c')
-  eq(child.fn.getcmdline(), tostring(cur_n_lines))
-
-  type_keys('0', '<CR>')
-  eq(child.lua_get('MiniSurround.config.n_lines'), 10 * cur_n_lines)
-end
-
-T['Update number of lines']['allows cancelling with `<Esc> and <C-c>`'] = function()
-  local validate_cancel = function(key)
-    child.ensure_normal_mode()
-    local cur_n_lines = child.lua_get('MiniSurround.config.n_lines')
-
-    type_keys('sn')
-    eq(child.fn.mode(), 'c')
-
-    type_keys(key)
-    eq(child.fn.mode(), 'n')
-    eq(child.lua_get('MiniSurround.config.n_lines'), cur_n_lines)
-  end
-
-  validate_cancel('<Esc>')
-  validate_cancel('<C-c>')
-end
-
-T['Update number of lines']['works with different mapping'] = function()
-  reload_module({ mappings = { update_n_lines = 'SN' } })
-
-  local cur_n_lines = child.lua_get('MiniSurround.config.n_lines')
-  type_keys('SN', '0', '<CR>')
-  child.api.nvim_del_keymap('n', 'SN')
-  eq(child.lua_get('MiniSurround.config.n_lines'), 10 * cur_n_lines)
-end
-
-T['Update number of lines']['respects `vim.{g,b}.minisurround_disable`'] = new_set({
-  parametrize = { { 'g' }, { 'b' } },
-}, {
-  test = function(var_type)
-    child[var_type].minisurround_disable = true
-    local cur_n_lines = child.lua_get('MiniSurround.config.n_lines')
-    type_keys('sn', '0', '<CR>')
-    eq(child.lua_get('MiniSurround.config.n_lines'), cur_n_lines)
-  end,
-})
-
 T['Search method'] = new_set()
 
 T['Search method']['works with "cover_or_prev"'] = function()