feat: introduce exclude option (#6)

Author: gbprod

README.md

@@ -51,18 +51,40 @@ Default : `nil`
 
 By default, this plugin doesn't remap the `<Del>` key to use the blackhole register (and it will work as the old `x` key). By setting `override_del` to true, `<Del>` key will not cut any more and not afect your current yank.
 
+### `exclude`
+
+Default: `{}`
+
+For some reason, you may doesn't want `cutlass` to override some keys, you can exclude mappings to be set by adding this to the exclude option using format `"{mode}{key}"`.
+
+Eg. If you want to exclude `s` key in normal mode, sets `exclude` option to `{ "ns" }` ; If you want to exclude `<bs>` key in select mode, sets `exclude` option to `{ "s<bs>" }`.
+
 ## Integration
 
+<details>
+<summary><b>svermeulen/vim-yoink</b></summary>
+
 If you have [svermeulen/vim-yoink](https://github.com/svermeulen/vim-yoink) installed, it will work seemlessly as original [svermeulen/vim-cutlass](https://github.com/svermeulen/vim-cutlass). Just follow the [integration instructions](https://github.com/svermeulen/vim-yoink#integration-with-vim-cutlass).
 
-## FAQ
+</details>
+
+<details>
+<summary><b>ggandor/lightspeed.nvim</b></summary>
 
-**What if I don't want cutlass to remap the `s` key ?**
+When you're using plugins like [ggandor/lightspeed.nvim](https://github.com/ggandor/lightspeed.nvim), you should not want cutlass to remap the `s` key. You can do this using the `exclude` option:
 
-When you're using plugins like [ggandor/lightspeed.nvim](https://github.com/ggandor/lightspeed.nvim), you should not want cutlass to remap the `s` key. Cutlass only map keys if no mapping has been set before.
-So, just check that you are calling the `setup` function after the lightspeed's `setup` function.
+```lua
+use({
+  "gbprod/cutlass.nvim",
+  config = function()
+    require("cutlass").setup({
+        exclude = { "ns", "nS" },
+    })
+  end
+})
+```
 
-(This advice could apply to other plugins ;) )
+</details>
 
 ## Credits
 

doc/cutlass.nvim.txt

@@ -8,7 +8,6 @@ Table of Contents                             *cutlass.nvim-table-of-contents*
   - Usage                                                 |cutlass.nvim-usage|
   - Configuration                                 |cutlass.nvim-configuration|
   - Integration                                     |cutlass.nvim-integration|
-  - FAQ                                                     |cutlass.nvim-faq|
   - Credits                                             |cutlass.nvim-credits|
 
 ==============================================================================
@@ -81,25 +80,45 @@ By default, this plugin doesn’t remap the `<Del>` key to use the blackhole
 register (and it will work as the old `x` key). By setting `override_del` to
 true, `<Del>` key will not cut any more and not afect your current yank.
 
+`EXCLUDE` ~
+
+Default: `{}`
+
+For some reason, you may doesn’t want `cutlass` to override some keys, you
+can exclude mappings to be set by adding this to the exclude option using
+format `"{mode}{key}"`.
+
+Eg. If you want to exclude `s` key in normal mode, sets `exclude` option to `{
+"ns" }` ; If you want to exclude `<bs>` key in select mode, sets `exclude`
+option to `{ "s<bs>" }`.
+
 INTEGRATION                                         *cutlass.nvim-integration*
 
+svermeulen/vim-yoink ~
+
 If you have svermeulen/vim-yoink <https://github.com/svermeulen/vim-yoink>
 installed, it will work seemlessly as original svermeulen/vim-cutlass
 <https://github.com/svermeulen/vim-cutlass>. Just follow the integration
 instructions
 <https://github.com/svermeulen/vim-yoink#integration-with-vim-cutlass>.
 
-FAQ                                                         *cutlass.nvim-faq*
-
-**What if I don’t want cutlass to remap the `s` key ?**
+ggandor/lightspeed.nvim ~
 
 When you’re using plugins like ggandor/lightspeed.nvim
 <https://github.com/ggandor/lightspeed.nvim>, you should not want cutlass to
-remap the `s` key. Cutlass only map keys if no mapping has been set before. So,
-just check that you are calling the `setup` function after the lightspeed’s
-`setup` function.
+remap the `s` key. You can do this using the `exclude` option:
+
+>
+    use({
+      "gbprod/cutlass.nvim",
+      config = function()
+        require("cutlass").setup({
+            exclude = { "ns", "nS" },
+        })
+      end
+    })
+<
 
-(This advice could apply to other plugins ;) )
 
 CREDITS                                                 *cutlass.nvim-credits*
 

lua/cutlass.lua

@@ -1,9 +1,19 @@
 local cutlass = {}
 
 local function with_defaults(options)
+  local flip = function(t)
+    local flipped = {}
+    for _, value in pairs(t) do
+      flipped[value] = true
+    end
+
+    return flipped
+  end
+
   return {
     cut_key = options.cut_key or nil,
     override_del = options.override_del or nil,
+    exclude = options.exclude and flip(options.exclude) or {},
   }
 end
 
@@ -34,7 +44,7 @@ function cutlass.override_delete_and_change_bindings()
 
   for _, override in ipairs(overrides) do
     for _, mode in ipairs(override.modes) do
-      if vim.fn.maparg(override.lhs, mode) == "" then
+      if not cutlass.options.exclude[mode .. override.lhs] and vim.fn.maparg(override.lhs, mode) == "" then
         map(mode, override.lhs, override.rhs, keymap_opts)
       end
     end
@@ -54,11 +64,18 @@ function cutlass.override_select_bindings()
   -- Add a map for every printable character to copy to black hole register
   for char_nr = 33, 126 do
     local char = vim.fn.nr2char(char_nr)
-    map("s", char, '<c-o>"_c' .. escape_rhs(char), keymap_opts)
+    if not cutlass.options.exclude["s" .. char] then
+      map("s", char, '<c-o>"_c' .. escape_rhs(char), keymap_opts)
+    end
+  end
+
+  if not cutlass.options.exclude["s<bs>"] then
+    map("s", "<bs>", '<c-o>"_c', keymap_opts)
   end
 
-  map("s", "<bs>", '<c-o>"_c', keymap_opts)
-  map("s", "<space>", '<c-o>"_c<space>', keymap_opts)
+  if not cutlass.options.exclude["s<space>"] then
+    map("s", "<space>", '<c-o>"_c<space>', keymap_opts)
+  end
 end
 
 function cutlass.create_cut_bindings()

spec/cutlass_spec.lua

@@ -10,13 +10,15 @@ end
 
 describe("Options should be set correctly", function()
   it("should take default values", function()
+    vim.cmd("mapclear")
     cutlass.setup()
     assert(cutlass.options.cut_key == nil)
   end)
 end)
 
 describe("Overrides delete and change mappings", function()
   it("should map change and delete keys", function()
+    vim.cmd("mapclear")
     cutlass.setup()
     local mappings = get_mappings("n")
 
@@ -27,6 +29,7 @@ describe("Overrides delete and change mappings", function()
   end)
 
   it("should map change and delete keys in x mode", function()
+    vim.cmd("mapclear")
     cutlass.setup()
     local mappings = get_mappings("x")
 
@@ -37,9 +40,10 @@ describe("Overrides delete and change mappings", function()
   end)
 
   it("should not override already mapped keys", function()
+    vim.cmd("mapclear")
     vim.api.nvim_set_keymap("n", "d", "gv", { noremap = true, silent = true })
-
     cutlass.setup()
+
     local mappings = get_mappings("n")
 
     assert(mappings["d"].rhs == "gv")
@@ -48,6 +52,7 @@ end)
 
 describe("Overrides select mode", function()
   it("should overrides select mode", function()
+    vim.cmd("mapclear")
     cutlass.setup()
     local mappings = get_mappings("s")
 
@@ -67,6 +72,7 @@ end)
 
 describe("Create cut mappings", function()
   it("should map cut keys if setup", function()
+    vim.cmd("mapclear")
     cutlass.setup({
       cut_key = "m",
     })
@@ -78,3 +84,21 @@ describe("Create cut mappings", function()
     assert(mappings["mm"].rhs, "dd")
   end)
 end)
+
+describe("Exclude option", function()
+  it("should not map excluded mapping", function()
+    vim.cmd("mapclear")
+    cutlass.setup({
+      exclude = { "ns", "nS", "sa", "s<bs>", "s<space>" },
+    })
+    local mappings = get_mappings("n")
+
+    assert(nil == mappings["s"])
+    assert(nil == mappings["S"])
+
+    mappings = get_mappings("s")
+    assert(nil == mappings["a"])
+    assert(nil == mappings["<bs>"])
+    assert(nil == mappings["<space>"])
+  end)
+end)