feat: lhs blacklists (#34)

Co-authored-by: Will Hopkins <willothyh@gmail.com> Co-authored-by: tris203 <admin@snappeh.com>
tris203 · Dec 21, 2023 · ce9dac1 · ce9dac1
1 parent f2e85f8
commit ce9dac1
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 16 deletions.
diff --git a/lua/hawtkeys/init.lua b/lua/hawtkeys/init.lua
@@ -10,9 +10,10 @@ local M = {}
 ---@field homerow number
 ---@field powerFingers number[]
 ---@field keyboardLayout HawtKeySupportedKeyboardLayouts
----@field keyMapSet { [string] : TSKeyMapArgs | WhichKeyMapargs } | nil
+---@field keyMapSet { [string] : TSKeyMapArgs | WhichKeyMapargs }
 ---@field customMaps { [string] : TSKeyMapArgs | WhichKeyMapargs } | nil
----@field highlights HawtKeyHighlights | nil
+---@field highlights HawtKeyHighlights
+---@field lhsBlacklist string[]
 
 ---@class HawtKeyHighlights
 ---@field HawtkeysMatchGreat vim.api.keyset.highlight | nil
@@ -27,6 +28,7 @@ local M = {}
 ---@field keyboardLayout HawtKeySupportedKeyboardLayouts | nil
 ---@field customMaps { [string] : TSKeyMapArgs | WhichKeyMapargs } | nil
 ---@field highlights HawtKeyHighlights | nil
+---@field lhsBlacklist string[] | nil
 
 ---@type { [string] : TSKeyMapArgs | WhichKeyMapargs }---
 local _defaultSet = {
@@ -49,6 +51,7 @@ local _defaultSet = {
     }, -- method 6
 }
 
+---@type HawtKeyConfig
 local defaultConfig = {
     leader = " ",
     homerow = 2,
@@ -61,6 +64,11 @@ local defaultConfig = {
         HawtkeysMatchOk = { link = "DiagnosticWarn" },
         HawtkeysMatchBad = { link = "DiagnosticError" },
     },
+    --[[
+<plug> is used internally by vim to map keys to functions
+Þ is used internally by whickkey to map NOP functions for menu popup timeout
+]]
+    lhsBlacklist = { "<plug>", "Þ" },
 }
 
 local function apply_highlights()

diff --git a/lua/hawtkeys/ts.lua b/lua/hawtkeys/ts.lua
@@ -356,20 +356,29 @@ local function get_keymaps_from_vim()
     local vimKeymaps = {}
 
     local vimKeymapsRaw = vim.api.nvim_get_keymap("")
-    print("Collecting vim keymaps")
-
     for _, vimKeymap in ipairs(vimKeymapsRaw) do
-        local rhs = vimKeymap.rhs
-        if rhs == nil or rhs == "" then
-            rhs = vimKeymap.desc
+        local count = vim.tbl_count(hawtkeys.config.lhsBlacklist)
+        for _, blacklist in ipairs(hawtkeys.config.lhsBlacklist) do
+            if not vimKeymap.lhs:lower():match(blacklist) then
+                count = count - 1
+                if count == 0 then
+                    local rhs = vimKeymap.rhs
+                    if rhs == nil or rhs == "" then
+                        rhs = vimKeymap.desc
+                    end
+                    table.insert(vimKeymaps, {
+                        mode = vimKeymap.mode,
+                        -- TODO: leader subsitiution as vim keymaps contain raw leader
+                        lhs = vimKeymap.lhs:gsub(
+                            hawtkeys.config.leader,
+                            "<leader>"
+                        ),
+                        rhs = rhs,
+                        from_file = "Vim Defaults",
+                    })
+                end
+            end
         end
-        table.insert(vimKeymaps, {
-            mode = vimKeymap.mode,
-            -- TODO: leader subsitiution as vim keymaps contain raw leader
-            rhs = rhs,
-            lhs = vimKeymap.lhs:gsub(hawtkeys.config.leader, "<leader>"),
-            from_file = "Vim Defaults",
-        })
     end
     return vimKeymaps
 end
@@ -409,5 +418,6 @@ M.reset_scanned_files = function()
 end
 
 M.find_maps_in_file = find_maps_in_file
+M.get_keymaps_from_vim = get_keymaps_from_vim
 
 return M
diff --git a/tests/hawtkeys/example_configs/blacklistCharacter_keymap.lua b/tests/hawtkeys/example_configs/blacklistCharacter_keymap.lua
@@ -0,0 +1,11 @@
+M = {}
+
+vim.api.nvim_set_keymap('n', '<Plug>Test', '', {})
+vim.api.nvim_set_keymap('n', '<leader>abÞ', '', {})
+
+M.reset = function()
+  vim.api.nvim_del_keymap('n', '<Plug>Test')
+  vim.api.nvim_del_keymap('n', '<leader>abÞ')
+end
+
+return  M
diff --git a/tests/hawtkeys/ts_spec.lua b/tests/hawtkeys/ts_spec.lua
@@ -2,6 +2,8 @@ local hawtkeys = require("hawtkeys")
 local ts = require("hawtkeys.ts")
 ---@diagnostic disable-next-line: undefined-field
 local eq = assert.are.same
+---@diagnostic disable-next-line: undefined-field
+local falsy = assert.falsy
 
 describe("Treesitter can extract keymaps", function()
     before_each(function()
@@ -58,7 +60,7 @@ describe("Treesitter can extract keymaps", function()
         hawtkeys.setup({
             customMaps = {
                 ["normalMap"] = {
-                    modeIndex = 'n',
+                    modeIndex = "n",
                     lhsIndex = 1,
                     rhsIndex = 2,
                     method = "function_call",
@@ -75,5 +77,21 @@ describe("Treesitter can extract keymaps", function()
         eq(':echo "hello"<CR>', keymap[2].rhs)
     end)
 
-
+    it("Keymaps containing blacklisted characters are ignored", function()
+        local numberOfExamples = 2
+        local beforeCount = #vim.api.nvim_get_keymap("n")
+        require("tests.hawtkeys.example_configs.blacklistCharacter_keymap")
+        local afterCount = #vim.api.nvim_get_keymap("n")
+        eq(numberOfExamples, afterCount - beforeCount)
+        local keymap = ts.get_keymaps_from_vim()
+        local blacklist = hawtkeys.config.lhsBlacklist
+        for _, map in pairs(keymap) do
+            for _, blacklistedItem in pairs(blacklist) do
+                falsy(string.find(map.lhs, blacklistedItem))
+            end
+        end
+        require("tests.hawtkeys.example_configs.blacklistCharacter_keymap").reset()
+        local finalCount = #vim.api.nvim_get_keymap("n")
+        eq(beforeCount, finalCount)
+    end)
 end)