feat(keybinds): change the way the leader key is passed around and refactor function names to make them more intuitive

Former-commit-id: 712b4ba

Author: vhyrro

lua/neorg/modules/core/keybinds/default_keybinds.lua

@@ -3,7 +3,9 @@ local module = neorg.modules.extend("core.keybinds.default_keybinds")
 ---@class core.keybinds
 module.config.public = {
     keybind_presets = {
-        neorg = function(keybinds, neorg_leader)
+        neorg = function(keybinds)
+            local leader = keybinds.leader
+
             -- Map all the below keybinds only when the "norg" mode is active
             keybinds.map_event_to_mode("norg", {
                 n = { -- Bind keys in normal mode
@@ -19,12 +21,12 @@ module.config.public = {
                     { "<C-Space>", "core.norg.qol.todo_items.todo.task_cycle" },
 
                     -- Keys for managing GTD
-                    { neorg_leader .. "tc", "core.gtd.base.capture" },
-                    { neorg_leader .. "tv", "core.gtd.base.views" },
-                    { neorg_leader .. "te", "core.gtd.base.edit" },
+                    { leader .. "tc", "core.gtd.base.capture" },
+                    { leader .. "tv", "core.gtd.base.views" },
+                    { leader .. "te", "core.gtd.base.edit" },
 
                     -- Keys for managing notes
-                    { neorg_leader .. "nn", "core.norg.dirman.new.note" },
+                    { leader .. "nn", "core.norg.dirman.new.note" },
 
                     { "<CR>", "core.norg.esupports.hop.hop-link" },
                     { "<M-CR>", "core.norg.esupports.hop.hop-link", "vsplit" },
@@ -33,7 +35,7 @@ module.config.public = {
                     { "<M-j>", "core.norg.manoeuvre.item_down" },
 
                     -- mnemonic: markup toggle
-                    { neorg_leader .. "mt", "core.norg.concealer.toggle-markup" },
+                    { leader .. "mt", "core.norg.concealer.toggle-markup" },
 
                     { "<C-s>", "core.integrations.telescope.find_linkable" },
                 },
@@ -116,8 +118,8 @@ module.config.public = {
             -- Apply the below keys to all modes
             keybinds.map_to_mode("all", {
                 n = {
-                    { neorg_leader .. "mn", ":Neorg mode norg<CR>" },
-                    { neorg_leader .. "mh", ":Neorg mode traverse-heading<CR>" },
+                    { leader .. "mn", ":Neorg mode norg<CR>" },
+                    { leader .. "mh", ":Neorg mode traverse-heading<CR>" },
                 },
             }, {
                 silent = true,

lua/neorg/modules/core/keybinds/module.lua

@@ -24,7 +24,7 @@ every keybind bit by bit.
     config = {
         hook = function(keybinds)
             keybinds.unmap("norg", "n", "gtd")
-            keybinds.remap("norg", "n", "<C-Space>", "gta")
+            keybinds.remap_event("norg", "n", "<C-Space>", "core.norg.qol.todo_items.todo.task_done")
         end,
     }
 }
@@ -258,16 +258,30 @@ module.public = {
                 bound_keys[neorg_mode][mode][key] = bound_keys[neorg_mode][mode][key] and nil
             end,
 
-            remap = function(neorg_mode, mode, old_key, new_key)
-                payload.rremap(neorg_mode, mode, old_key, mode, new_key)
+            remap = function(neorg_mode, mode, key, new_rhs)
+                local opts = bound_keys[neorg_mode][mode][key].opts
+
+                payload.map(neorg_mode, mode, key, new_rhs, opts)
+            end,
+
+            remap_event = function(neorg_mode, mode, key, new_event)
+                local opts = bound_keys[neorg_mode][mode][key].opts
+
+                payload.map(
+                    neorg_mode,
+                    mode,
+                    key,
+                    "<cmd>Neorg keybind " .. neorg_mode .. " " .. new_event .. "<CR>",
+                    opts
+                )
             end,
 
-            rremap = function(neorg_mode, mode, old_key, new_mode, new_key)
+            remap_key = function(neorg_mode, mode, old_key, new_key)
                 local command = bound_keys[neorg_mode][mode][old_key].command
                 local opts = bound_keys[neorg_mode][mode][old_key].opts
 
                 payload.unmap(neorg_mode, mode, old_key)
-                payload.map(neorg_mode, new_mode, new_key, command, opts)
+                payload.map(neorg_mode, mode, new_key, command, opts)
             end,
 
             -- @Summary Maps a bunch of keys for a certain mode
@@ -333,21 +347,21 @@ module.public = {
             leader = module.config.public.neorg_leader,
         }
 
-        --- Generates a set of default functions for a given list of them
-        --  Default functions are postfixed with "d" and omit the beginning "neorg_mode"
-        --  parameter. The string "norg" is used in those places.
-        --- @vararg string A list of strings that define the functions to be given a default counterpart
-        local function generate_default_functions(...)
+        local function generate_default_functions(cb, ...)
             local funcs = { ... }
 
             for _, func in ipairs(funcs) do
-                payload[func .. "d"] = function(...)
-                    payload[func]("norg", ...)
-                end
+                local name, to_exec = cb(func, payload[func])
+
+                payload[name] = to_exec
             end
         end
 
-        generate_default_functions("map", "map_event", "unmap", "remap")
+        generate_default_functions(function(name, func)
+            return name .. "d", function(...)
+                func("norg", ...)
+            end
+        end, "map", "map_event", "unmap", "remap", "remap_key", "remap_event")
 
         if
             module.config.public.default_keybinds