feat(surround)!: map s to <Nop> if any of the mappings start with it

Details:
- This prevents accidental trigger of built-in `s` if there is a long
  delay between pressing "s" and the next key.
  This was previously a documented improvement, but it makes sense to do
  automatically during `setup()` because it improves default behavior
  (without much harm for non-default one).

Author: echasnovski

CHANGELOG.md

@@ -155,6 +155,8 @@ There are following change types:
 
 - 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()`.
 
+- Automatically map `s` key to `<Nop>` if any of created mappings start with it. This prevents accidental trigger of built-in `s` if there is a long delay between pressing "s" and the next key.
+
 ### 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

@@ -541,11 +541,10 @@ Defaults ~
 By default it uses "prefix style" left hand side starting with "s" (for
 "surround"): `sa` - "surround add", `sd` - "surround delete", etc.
 
-Note: if 'timeoutlen' is low enough to cause occasional usage of |s| key
-(that deletes character under cursor), disable it with the following call: >lua
+Note: if any of the mappings start with "s" (as is by default), it is mapped
+to |<Nop>| to prevent accidental trigger of built-in |s| (can happen if there
+is a long enough delay between pressing "s" and the next key). Use `cl` instead.
 
-  vim.keymap.set({ 'n', 'x' }, 's', '<Nop>')
-<
 # Custom surroundings ~
 
 User can define own surroundings by supplying `config.custom_surroundings`.

lua/mini/surround.lua

@@ -508,11 +508,10 @@ end
 --- By default it uses "prefix style" left hand side starting with "s" (for
 --- "surround"): `sa` - "surround add", `sd` - "surround delete", etc.
 ---
---- Note: if 'timeoutlen' is low enough to cause occasional usage of |s| key
---- (that deletes character under cursor), disable it with the following call: >lua
+--- Note: if any of the mappings start with "s" (as is by default), it is mapped
+--- to |<Nop>| to prevent accidental trigger of built-in |s| (can happen if there
+--- is a long enough delay between pressing "s" and the next key). Use `cl` instead.
 ---
----   vim.keymap.set({ 'n', 'x' }, 's', '<Nop>')
---- <
 --- # Custom surroundings ~
 ---
 --- User can define own surroundings by supplying `config.custom_surroundings`.
@@ -2266,6 +2265,7 @@ H.map = function(mode, lhs, rhs, opts)
   if lhs == '' then return end
   opts = vim.tbl_deep_extend('force', { silent = true }, opts or {})
   vim.keymap.set(mode, lhs, rhs, opts)
+  if lhs:sub(1, 1) == 's' then vim.keymap.set(mode, 's', '<Nop>') end
 end
 
 H.get_line_cols = function(line_num) return vim.fn.getline(line_num):len() end

tests/test_surround.lua

@@ -171,6 +171,10 @@ T['setup()']['properly handles `config.mappings`'] = function()
   -- Regular mappings
   eq(has_map('sa', 'surround'), true)
 
+  -- Should map "s" to <Nop>, but only if needed
+  eq(child.fn.maparg('s', 'n'), '<Nop>')
+  eq(child.fn.maparg('s', 'x'), '<Nop>')
+
   unload_module()
   child.api.nvim_del_keymap('n', 'sa')
 
@@ -194,6 +198,32 @@ T['setup()']['properly handles `config.mappings`'] = function()
   eq(has_map('sdn', 'next'), false)
   eq(has_map('srl', 'previous'), false)
   eq(has_map('srn', 'next'), true)
+
+  -- Should precisely set 's' keymap
+  unload_module()
+  child.api.nvim_del_keymap('n', 'sa')
+  child.api.nvim_del_keymap('n', 's')
+  child.api.nvim_del_keymap('x', 's')
+
+  load_module({ mappings = { add = 'cs' } })
+  eq(child.fn.maparg('s', 'n'), '<Nop>')
+  eq(child.fn.maparg('s', 'x'), '')
+
+  child.api.nvim_del_keymap('n', 's')
+  load_module({
+    mappings = {
+      add = 'ys',
+      delete = 'ds',
+      find = '',
+      find_left = '',
+      highlight = '',
+      replace = 'cs',
+      suffix_last = '',
+      suffix_next = '',
+    },
+  })
+  eq(child.fn.maparg('s', 'n'), '')
+  eq(child.fn.maparg('s', 'x'), '')
 end
 
 T['update_n_lines()'] = new_set({