fix(operators): better document and test gx remapping to gX

Author: echasnovski

doc/mini-operators.txt

@@ -186,6 +186,7 @@ Default values:
 
     -- Exchange text regions
     exchange = {
+      -- NOTE: Default `gx` is remapped to `gX`
       prefix = 'gx',
 
       -- Whether to reindent new text to match previous indent
@@ -202,6 +203,7 @@ Default values:
 
     -- Replace text with register
     replace = {
+      -- NOTE: Default `gr*` LSP mappings are removed
       prefix = 'gr',
 
       -- Whether to reindent new text to match previous indent

lua/mini/operators.lua

@@ -284,6 +284,7 @@ MiniOperators.config = {
 
   -- Exchange text regions
   exchange = {
+    -- NOTE: Default `gx` is remapped to `gX`
     prefix = 'gx',
 
     -- Whether to reindent new text to match previous indent
@@ -300,6 +301,7 @@ MiniOperators.config = {
 
   -- Replace text with register
   replace = {
+    -- NOTE: Default `gr*` LSP mappings are removed
     prefix = 'gr',
 
     -- Whether to reindent new text to match previous indent

readmes/mini-operators.md

@@ -158,6 +158,7 @@ Here are code snippets for some common installation methods (use only one):
 
   -- Exchange text regions
   exchange = {
+    -- NOTE: Default `gx` is remapped to `gX`
     prefix = 'gx',
 
     -- Whether to reindent new text to match previous indent
@@ -174,6 +175,7 @@ Here are code snippets for some common installation methods (use only one):
 
   -- Replace text with register
   replace = {
+    -- NOTE: Default `gr*` LSP mappings are removed
     prefix = 'gr',
 
     -- Whether to reindent new text to match previous indent

tests/test_operators.lua

@@ -150,16 +150,18 @@ T['setup()']['remaps built-in `gx` mappings'] = function()
   validate('vgX', 2)
 
   -- Should remap only built-in `gx`
+  child.lua('vim.keymap.del({ "n", "x" }, "gX")')
   child.lua('vim.keymap.set({ "n", "x" }, "gx", function() _G.n = _G.n + 5 end)')
   child.lua('MiniOperators.setup()')
-  validate('gX', 3)
-  validate('vgX', 4)
+  validate('gX', 2)
+  validate('vgX', 2)
 
   -- Should not override already present mapping
+  child.lua('vim.keymap.set({ "n", "x" }, "gx", function() _G.n = _G.n + 5 end, { desc = "URI under cursor" })')
   child.lua('vim.keymap.set({ "n", "x" }, "gX", function() _G.n = _G.n + 10 end)')
   child.lua('MiniOperators.setup()')
-  validate('gX', 14)
-  validate('vgX', 24)
+  validate('gX', 12)
+  validate('vgX', 22)
 end
 
 T['evaluate()'] = new_set()