Merge branch 'main' into fix/Format-keymap

Signed-off-by: ayamir <[email protected]>

lua/keymap/completion.lua

@@ -2,15 +2,21 @@ local bind = require("keymap.bind")
 local map_cr = bind.map_cr
 local map_callback = bind.map_callback
 
-local plug_map = {
-	["n|<A-f>"] = map_cr("FormatToggle"):with_noremap():with_silent():with_desc("formatter: Toggle format on save"),
-	["n|<A-S-f>"] = map_cr("Format"):with_noremap():with_silent():with_desc("formatter: Format buffer manually"),
+local mappings = {
+	fmt = {
+		["n|<A-f>"] = map_cr("FormatToggle"):with_noremap():with_silent():with_desc("formatter: Toggle format on save"),
+		["n|<A-S-f>"] = map_cr("Format"):with_noremap():with_silent():with_desc("formatter: Format buffer manually"),
+	},
 }
-bind.nvim_load_mapping(plug_map)
+bind.nvim_load_mapping(mappings.fmt)
 
-local mapping = {}
+--- The following code allows this file to be exported ---
+---    for use with LSP lazy-loaded keymap bindings    ---
 
-function mapping.lsp(buf)
+local M = {}
+
+---@param buf integer
+function M.lsp(buf)
 	local map = {
 		-- LSP-related keymaps, ONLY effective in buffers with LSP(s) attached
 		["n|<leader>li"] = map_cr("LspInfo"):with_silent():with_buffer(buf):with_desc("lsp: Info"),
@@ -82,4 +88,4 @@ function mapping.lsp(buf)
 	end
 end
 
-return mapping
+return M

lua/keymap/editor.lua

@@ -5,136 +5,136 @@ local map_cmd = bind.map_cmd
 local map_callback = bind.map_callback
 local et = bind.escape_termcode
 
-local builtin_map = {
-	-- Builtin: save & quit
-	["n|<C-s>"] = map_cu("write"):with_noremap():with_silent():with_desc("edit: Save file"),
-	["n|<C-q>"] = map_cr("wq"):with_desc("edit: Save file and quit"),
-	["n|<A-S-q>"] = map_cr("q!"):with_desc("edit: Force quit"),
+local mappings = {
+	builtins = {
+		-- Builtins: Save & Quit
+		["n|<C-s>"] = map_cu("write"):with_noremap():with_silent():with_desc("edit: Save file"),
+		["n|<C-q>"] = map_cr("wq"):with_desc("edit: Save file and quit"),
+		["n|<A-S-q>"] = map_cr("q!"):with_desc("edit: Force quit"),
 
-	-- Builtin: insert mode
-	["i|<C-u>"] = map_cmd("<C-G>u<C-U>"):with_noremap():with_desc("edit: Delete previous block"),
-	["i|<C-b>"] = map_cmd("<Left>"):with_noremap():with_desc("edit: Move cursor to left"),
-	["i|<C-a>"] = map_cmd("<ESC>^i"):with_noremap():with_desc("edit: Move cursor to line start"),
-	["i|<C-s>"] = map_cmd("<Esc>:w<CR>"):with_desc("edit: Save file"),
-	["i|<C-q>"] = map_cmd("<Esc>:wq<CR>"):with_desc("edit: Save file and quit"),
+		-- Builtins: Insert mode
+		["i|<C-u>"] = map_cmd("<C-G>u<C-U>"):with_noremap():with_desc("edit: Delete previous block"),
+		["i|<C-b>"] = map_cmd("<Left>"):with_noremap():with_desc("edit: Move cursor to left"),
+		["i|<C-a>"] = map_cmd("<ESC>^i"):with_noremap():with_desc("edit: Move cursor to line start"),
+		["i|<C-s>"] = map_cmd("<Esc>:w<CR>"):with_desc("edit: Save file"),
+		["i|<C-q>"] = map_cmd("<Esc>:wq<CR>"):with_desc("edit: Save file and quit"),
 
-	-- Builtin: command mode
-	["c|<C-b>"] = map_cmd("<Left>"):with_noremap():with_desc("edit: Left"),
-	["c|<C-f>"] = map_cmd("<Right>"):with_noremap():with_desc("edit: Right"),
-	["c|<C-a>"] = map_cmd("<Home>"):with_noremap():with_desc("edit: Home"),
-	["c|<C-e>"] = map_cmd("<End>"):with_noremap():with_desc("edit: End"),
-	["c|<C-d>"] = map_cmd("<Del>"):with_noremap():with_desc("edit: Delete"),
-	["c|<C-h>"] = map_cmd("<BS>"):with_noremap():with_desc("edit: Backspace"),
-	["c|<C-t>"] = map_cmd([[<C-R>=expand("%:p:h") . "/" <CR>]])
-		:with_noremap()
-		:with_desc("edit: Complete path of current file"),
+		-- Builtins: Command mode
+		["c|<C-b>"] = map_cmd("<Left>"):with_noremap():with_desc("edit: Left"),
+		["c|<C-f>"] = map_cmd("<Right>"):with_noremap():with_desc("edit: Right"),
+		["c|<C-a>"] = map_cmd("<Home>"):with_noremap():with_desc("edit: Home"),
+		["c|<C-e>"] = map_cmd("<End>"):with_noremap():with_desc("edit: End"),
+		["c|<C-d>"] = map_cmd("<Del>"):with_noremap():with_desc("edit: Delete"),
+		["c|<C-h>"] = map_cmd("<BS>"):with_noremap():with_desc("edit: Backspace"),
+		["c|<C-t>"] = map_cmd([[<C-R>=expand("%:p:h") . "/" <CR>]])
+			:with_noremap()
+			:with_desc("edit: Complete path of current file"),
 
-	-- Builtin: visual mode
-	["v|J"] = map_cmd(":m '>+1<CR>gv=gv"):with_desc("edit: Move this line down"),
-	["v|K"] = map_cmd(":m '<-2<CR>gv=gv"):with_desc("edit: Move this line up"),
-	["v|<"] = map_cmd("<gv"):with_desc("edit: Decrease indent"),
-	["v|>"] = map_cmd(">gv"):with_desc("edit: Increase indent"),
+		-- Builtins: Visual mode
+		["v|J"] = map_cmd(":m '>+1<CR>gv=gv"):with_desc("edit: Move this line down"),
+		["v|K"] = map_cmd(":m '<-2<CR>gv=gv"):with_desc("edit: Move this line up"),
+		["v|<"] = map_cmd("<gv"):with_desc("edit: Decrease indent"),
+		["v|>"] = map_cmd(">gv"):with_desc("edit: Increase indent"),
 
-	-- Builtin: suckless
-	["n|Y"] = map_cmd("y$"):with_desc("edit: Yank text to EOL"),
-	["n|D"] = map_cmd("d$"):with_desc("edit: Delete text to EOL"),
-	["n|n"] = map_cmd("nzzzv"):with_noremap():with_desc("edit: Next search result"),
-	["n|N"] = map_cmd("Nzzzv"):with_noremap():with_desc("edit: Prev search result"),
-	["n|J"] = map_cmd("mzJ`z"):with_noremap():with_desc("edit: Join next line"),
-	["n|<S-Tab>"] = map_cr("normal za"):with_noremap():with_silent():with_desc("edit: Toggle code fold"),
-	["n|<Esc>"] = map_callback(function()
-			_flash_esc_or_noh()
-		end)
-		:with_noremap()
-		:with_silent()
-		:with_desc("edit: Clear search highlight"),
-	["n|<leader>o"] = map_cr("setlocal spell! spelllang=en_us"):with_desc("edit: Toggle spell check"),
-}
-
-bind.nvim_load_mapping(builtin_map)
-
-local plug_map = {
-	-- Plugin: persisted.nvim
-	["n|<leader>ss"] = map_cu("SessionSave"):with_noremap():with_silent():with_desc("session: Save"),
-	["n|<leader>sl"] = map_cu("SessionLoad"):with_noremap():with_silent():with_desc("session: Load current"),
-	["n|<leader>sd"] = map_cu("SessionDelete"):with_noremap():with_silent():with_desc("session: Delete"),
+		-- Builtins: "Suckless" - named after r/suckless
+		["n|Y"] = map_cmd("y$"):with_desc("edit: Yank text to EOL"),
+		["n|D"] = map_cmd("d$"):with_desc("edit: Delete text to EOL"),
+		["n|n"] = map_cmd("nzzzv"):with_noremap():with_desc("edit: Next search result"),
+		["n|N"] = map_cmd("Nzzzv"):with_noremap():with_desc("edit: Prev search result"),
+		["n|J"] = map_cmd("mzJ`z"):with_noremap():with_desc("edit: Join next line"),
+		["n|<S-Tab>"] = map_cr("normal za"):with_noremap():with_silent():with_desc("edit: Toggle code fold"),
+		["n|<Esc>"] = map_callback(function()
+				_flash_esc_or_noh()
+			end)
+			:with_noremap()
+			:with_silent()
+			:with_desc("edit: Clear search highlight"),
+		["n|<leader>o"] = map_cr("setlocal spell! spelllang=en_us"):with_desc("edit: Toggle spell check"),
+	},
+	plugins = {
+		-- Plugin: persisted.nvim
+		["n|<leader>ss"] = map_cu("SessionSave"):with_noremap():with_silent():with_desc("session: Save"),
+		["n|<leader>sl"] = map_cu("SessionLoad"):with_noremap():with_silent():with_desc("session: Load current"),
+		["n|<leader>sd"] = map_cu("SessionDelete"):with_noremap():with_silent():with_desc("session: Delete"),
 
-	-- Plugin: comment.nvim
-	["n|gcc"] = map_callback(function()
-			return vim.v.count == 0 and et("<Plug>(comment_toggle_linewise_current)")
-				or et("<Plug>(comment_toggle_linewise_count)")
-		end)
-		:with_silent()
-		:with_noremap()
-		:with_expr()
-		:with_desc("edit: Toggle comment for line"),
-	["n|gbc"] = map_callback(function()
-			return vim.v.count == 0 and et("<Plug>(comment_toggle_blockwise_current)")
-				or et("<Plug>(comment_toggle_blockwise_count)")
-		end)
-		:with_silent()
-		:with_noremap()
-		:with_expr()
-		:with_desc("edit: Toggle comment for block"),
-	["n|gc"] = map_cmd("<Plug>(comment_toggle_linewise)")
-		:with_silent()
-		:with_noremap()
-		:with_desc("edit: Toggle comment for line with operator"),
-	["n|gb"] = map_cmd("<Plug>(comment_toggle_blockwise)")
-		:with_silent()
-		:with_noremap()
-		:with_desc("edit: Toggle comment for block with operator"),
-	["x|gc"] = map_cmd("<Plug>(comment_toggle_linewise_visual)")
-		:with_silent()
-		:with_noremap()
-		:with_desc("edit: Toggle comment for line with selection"),
-	["x|gb"] = map_cmd("<Plug>(comment_toggle_blockwise_visual)")
-		:with_silent()
-		:with_noremap()
-		:with_desc("edit: Toggle comment for block with selection"),
+		-- Plugin: comment.nvim
+		["n|gcc"] = map_callback(function()
+				return vim.v.count == 0 and et("<Plug>(comment_toggle_linewise_current)")
+					or et("<Plug>(comment_toggle_linewise_count)")
+			end)
+			:with_silent()
+			:with_noremap()
+			:with_expr()
+			:with_desc("edit: Toggle comment for line"),
+		["n|gbc"] = map_callback(function()
+				return vim.v.count == 0 and et("<Plug>(comment_toggle_blockwise_current)")
+					or et("<Plug>(comment_toggle_blockwise_count)")
+			end)
+			:with_silent()
+			:with_noremap()
+			:with_expr()
+			:with_desc("edit: Toggle comment for block"),
+		["n|gc"] = map_cmd("<Plug>(comment_toggle_linewise)")
+			:with_silent()
+			:with_noremap()
+			:with_desc("edit: Toggle comment for line with operator"),
+		["n|gb"] = map_cmd("<Plug>(comment_toggle_blockwise)")
+			:with_silent()
+			:with_noremap()
+			:with_desc("edit: Toggle comment for block with operator"),
+		["x|gc"] = map_cmd("<Plug>(comment_toggle_linewise_visual)")
+			:with_silent()
+			:with_noremap()
+			:with_desc("edit: Toggle comment for line with selection"),
+		["x|gb"] = map_cmd("<Plug>(comment_toggle_blockwise_visual)")
+			:with_silent()
+			:with_noremap()
+			:with_desc("edit: Toggle comment for block with selection"),
 
-	-- Plugin: diffview.nvim
-	["n|<leader>gd"] = map_cr("DiffviewOpen"):with_silent():with_noremap():with_desc("git: Show diff"),
-	["n|<leader>gD"] = map_cr("DiffviewClose"):with_silent():with_noremap():with_desc("git: Close diff"),
+		-- Plugin: diffview.nvim
+		["n|<leader>gd"] = map_cr("DiffviewOpen"):with_silent():with_noremap():with_desc("git: Show diff"),
+		["n|<leader>gD"] = map_cr("DiffviewClose"):with_silent():with_noremap():with_desc("git: Close diff"),
 
-	-- Plugin: hop.nvim
-	["nv|<leader>w"] = map_cmd("<Cmd>HopWordMW<CR>"):with_noremap():with_desc("jump: Goto word"),
-	["nv|<leader>j"] = map_cmd("<Cmd>HopLineMW<CR>"):with_noremap():with_desc("jump: Goto line"),
-	["nv|<leader>k"] = map_cmd("<Cmd>HopLineMW<CR>"):with_noremap():with_desc("jump: Goto line"),
-	["nv|<leader>c"] = map_cmd("<Cmd>HopChar1MW<CR>"):with_noremap():with_desc("jump: Goto one char"),
-	["nv|<leader>C"] = map_cmd("<Cmd>HopChar2MW<CR>"):with_noremap():with_desc("jump: Goto two chars"),
+		-- Plugin: hop.nvim
+		["nv|<leader>w"] = map_cmd("<Cmd>HopWordMW<CR>"):with_noremap():with_desc("jump: Goto word"),
+		["nv|<leader>j"] = map_cmd("<Cmd>HopLineMW<CR>"):with_noremap():with_desc("jump: Goto line"),
+		["nv|<leader>k"] = map_cmd("<Cmd>HopLineMW<CR>"):with_noremap():with_desc("jump: Goto line"),
+		["nv|<leader>c"] = map_cmd("<Cmd>HopChar1MW<CR>"):with_noremap():with_desc("jump: Goto one char"),
+		["nv|<leader>C"] = map_cmd("<Cmd>HopChar2MW<CR>"):with_noremap():with_desc("jump: Goto two chars"),
 
-	-- Plugin: nvim-spectre
-	["n|<leader>Ss"] = map_callback(function()
-			require("spectre").toggle()
-		end)
-		:with_silent()
-		:with_noremap()
-		:with_desc("editn: Toggle search & replace panel"),
-	["n|<leader>Sp"] = map_callback(function()
-			require("spectre").open_visual({ select_word = true })
-		end)
-		:with_silent()
-		:with_noremap()
-		:with_desc("editn: search&replace current word (project)"),
-	["v|<leader>Sp"] = map_callback(function()
-			require("spectre").open_visual()
-		end)
-		:with_silent()
-		:with_noremap()
-		:with_desc("edit: search & replace current word (project)"),
-	["n|<leader>Sf"] = map_callback(function()
-			require("spectre").open_file_search({ select_word = true })
-		end)
-		:with_silent()
-		:with_noremap()
-		:with_desc("editn: search & replace current word (file)"),
+		-- Plugin: nvim-spectre
+		["n|<leader>Ss"] = map_callback(function()
+				require("spectre").toggle()
+			end)
+			:with_silent()
+			:with_noremap()
+			:with_desc("editn: Toggle search & replace panel"),
+		["n|<leader>Sp"] = map_callback(function()
+				require("spectre").open_visual({ select_word = true })
+			end)
+			:with_silent()
+			:with_noremap()
+			:with_desc("editn: search&replace current word (project)"),
+		["v|<leader>Sp"] = map_callback(function()
+				require("spectre").open_visual()
+			end)
+			:with_silent()
+			:with_noremap()
+			:with_desc("edit: search & replace current word (project)"),
+		["n|<leader>Sf"] = map_callback(function()
+				require("spectre").open_file_search({ select_word = true })
+			end)
+			:with_silent()
+			:with_noremap()
+			:with_desc("editn: search & replace current word (file)"),
 
-	-- Plugin: nvim-treehopper
-	["o|m"] = map_cu("lua require('tsht').nodes()"):with_silent():with_desc("jump: Operate across syntax tree"),
+		-- Plugin: nvim-treehopper
+		["o|m"] = map_cu("lua require('tsht').nodes()"):with_silent():with_desc("jump: Operate across syntax tree"),
 
-	-- Plugin: suda.vim
-	["n|<A-s>"] = map_cu("SudaWrite"):with_silent():with_noremap():with_desc("editn: Save file using sudo"),
+		-- Plugin: suda.vim
+		["n|<A-s>"] = map_cu("SudaWrite"):with_silent():with_noremap():with_desc("editn: Save file using sudo"),
+	},
 }
 
-bind.nvim_load_mapping(plug_map)
+bind.nvim_load_mapping(mappings.builtins)
+bind.nvim_load_mapping(mappings.plugins)

lua/keymap/init.lua

@@ -1,35 +1,50 @@
 require("keymap.helpers")
 local bind = require("keymap.bind")
 local map_cr = bind.map_cr
--- local map_cu = bind.map_cu
--- local map_cmd = bind.map_cmd
--- local map_callback = bind.map_callback
 
-local plug_map = {
-	-- Package manager: lazy.nvim
-	["n|<leader>ph"] = map_cr("Lazy"):with_silent():with_noremap():with_nowait():with_desc("package: Show"),
-	["n|<leader>ps"] = map_cr("Lazy sync"):with_silent():with_noremap():with_nowait():with_desc("package: Sync"),
-	["n|<leader>pu"] = map_cr("Lazy update"):with_silent():with_noremap():with_nowait():with_desc("package: Update"),
-	["n|<leader>pi"] = map_cr("Lazy install"):with_silent():with_noremap():with_nowait():with_desc("package: Install"),
-	["n|<leader>pl"] = map_cr("Lazy log"):with_silent():with_noremap():with_nowait():with_desc("package: Log"),
-	["n|<leader>pc"] = map_cr("Lazy check"):with_silent():with_noremap():with_nowait():with_desc("package: Check"),
-	["n|<leader>pd"] = map_cr("Lazy debug"):with_silent():with_noremap():with_nowait():with_desc("package: Debug"),
-	["n|<leader>pp"] = map_cr("Lazy profile"):with_silent():with_noremap():with_nowait():with_desc("package: Profile"),
-	["n|<leader>pr"] = map_cr("Lazy restore"):with_silent():with_noremap():with_nowait():with_desc("package: Restore"),
-	["n|<leader>px"] = map_cr("Lazy clean"):with_silent():with_noremap():with_nowait():with_desc("package: Clean"),
+local mappings = {
+	core = {
+		-- Package manager: lazy.nvim
+		["n|<leader>ph"] = map_cr("Lazy"):with_silent():with_noremap():with_nowait():with_desc("package: Show"),
+		["n|<leader>ps"] = map_cr("Lazy sync"):with_silent():with_noremap():with_nowait():with_desc("package: Sync"),
+		["n|<leader>pu"] = map_cr("Lazy update")
+			:with_silent()
+			:with_noremap()
+			:with_nowait()
+			:with_desc("package: Update"),
+		["n|<leader>pi"] = map_cr("Lazy install")
+			:with_silent()
+			:with_noremap()
+			:with_nowait()
+			:with_desc("package: Install"),
+		["n|<leader>pl"] = map_cr("Lazy log"):with_silent():with_noremap():with_nowait():with_desc("package: Log"),
+		["n|<leader>pc"] = map_cr("Lazy check"):with_silent():with_noremap():with_nowait():with_desc("package: Check"),
+		["n|<leader>pd"] = map_cr("Lazy debug"):with_silent():with_noremap():with_nowait():with_desc("package: Debug"),
+		["n|<leader>pp"] = map_cr("Lazy profile")
+			:with_silent()
+			:with_noremap()
+			:with_nowait()
+			:with_desc("package: Profile"),
+		["n|<leader>pr"] = map_cr("Lazy restore")
+			:with_silent()
+			:with_noremap()
+			:with_nowait()
+			:with_desc("package: Restore"),
+		["n|<leader>px"] = map_cr("Lazy clean"):with_silent():with_noremap():with_nowait():with_desc("package: Clean"),
+	},
 }
 
-bind.nvim_load_mapping(plug_map)
+bind.nvim_load_mapping(mappings.core)
 
--- Plugin keymaps
+-- Builtin & Plugin keymaps
 require("keymap.completion")
 require("keymap.editor")
 require("keymap.lang")
 require("keymap.tool")
 require("keymap.ui")
 
 -- User keymaps
-local ok, mappings = pcall(require, "user.keymap.init")
+local ok, def = pcall(require, "user.keymap.init")
 if ok then
-	require("modules.utils.keymap").replace(mappings)
+	require("modules.utils.keymap").replace(def)
 end

lua/keymap/lang.lua

@@ -1,17 +1,16 @@
 local bind = require("keymap.bind")
 local map_cr = bind.map_cr
--- local map_cu = bind.map_cu
--- local map_cmd = bind.map_cmd
--- local map_callback = bind.map_callback
 
-local plug_map = {
-	-- Plugin render-markdown.nvim
-	["n|<F1>"] = map_cr("RenderMarkdown toggle")
-		:with_noremap()
-		:with_silent()
-		:with_desc("tool: toggle markdown preview within nvim"),
-	-- Plugin MarkdownPreview
-	["n|<F12>"] = map_cr("MarkdownPreviewToggle"):with_noremap():with_silent():with_desc("tool: Preview markdown"),
+local mappings = {
+	plugins = {
+		-- Plugins: render-markdown.nvim
+		["n|<F1>"] = map_cr("RenderMarkdown toggle")
+			:with_noremap()
+			:with_silent()
+			:with_desc("tool: toggle markdown preview within nvim"),
+		-- Plugins: MarkdownPreview
+		["n|<F12>"] = map_cr("MarkdownPreviewToggle"):with_noremap():with_silent():with_desc("tool: Preview markdown"),
+	},
 }
 
-bind.nvim_load_mapping(plug_map)
+bind.nvim_load_mapping(mappings.plugins)