refactor: keymap configs

chrisgrieser · Dec 24, 2024 · 37babba · 37babba
1 parent 14467ef
commit 37babba
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -118,8 +118,8 @@ require("rip-substitute").setup {
 		abort = "q",
 		confirm = "<CR>",
 		insertModeConfirm = "<C-CR>",
-		prevSubst = "<Up>",
-		nextSubst = "<Down>",
+		prevSubstitutionInHistory = "<Up>",
+		nextSubstitutionInHistory = "<Down>",
 		toggleFixedStrings = "<C-f>", -- ripgrep's `--fixed-strings`
 		toggleIgnoreCase = "<C-c>", -- ripgrep's `--ignore-case`
 		openAtRegex101 = "R",

diff --git a/lua/rip-substitute/config.lua b/lua/rip-substitute/config.lua
@@ -22,8 +22,8 @@ local defaultConfig = {
 		abort = "q",
 		confirm = "<CR>",
 		insertModeConfirm = "<C-CR>",
-		prevSubst = "<Up>",
-		nextSubst = "<Down>",
+		prevSubstitutionInHistory = "<Up>",
+		nextSubstitutionInHistory = "<Down>",
 		toggleFixedStrings = "<C-f>", -- ripgrep's `--fixed-strings`
 		toggleIgnoreCase = "<C-c>", -- ripgrep's `--ignore-case`
 		openAtRegex101 = "R",
@@ -72,12 +72,18 @@ function M.setup(userConfig)
 		require("rip-substitute.state").state.useIgnoreCase = true
 	end
 
-	-- DEPRECATION
+	-- DEPRECATION (2024-11-20)
 	if M.config.notificationOnSuccess then ---@diagnostic disable-line: undefined-field
 		local msg =
 			"`notificationOnSuccess` has been deprecated. Use `notification.onSuccess` instead."
 		notify(msg, "warn")
 	end
+	-- DEPRECATION (2024-11-20)
+	if M.config.keymaps.prevSubst or M.config.keymaps.nextSubst then ---@diagnostic disable-line: undefined-field
+		local msg = "`keymaps.prevSubst` and `keymaps.prevSubst` have been deprecated. "
+			.. "Use `keymaps.prevSubstitutionInHistory` and `keymaps.nextSubstitutionInHistory` instead."
+		notify(msg, "warn")
+	end
 
 	-- VALIDATE `rg` installations not built with `pcre2`, see #3
 	if M.config.regexOptions.pcre2 then

diff --git a/lua/rip-substitute/popup-win.lua b/lua/rip-substitute/popup-win.lua
@@ -253,7 +253,7 @@ local function createKeymaps()
 
 	-- history keymaps
 	state.historyPosition = #state.popupHistory + 1
-	keymap("n", maps.prevSubst, function()
+	keymap("n", maps.prevSubstitutionInHistory, function()
 		if state.historyPosition < 2 then return end
 		if state.historyPosition == #state.popupHistory + 1 then
 			state.popupPresentContent = vim.api.nvim_buf_get_lines(state.popupBufNr, 0, -1, true)
@@ -262,7 +262,7 @@ local function createKeymaps()
 		local content = state.popupHistory[state.historyPosition]
 		vim.api.nvim_buf_set_lines(state.popupBufNr, 0, -1, false, content)
 	end)
-	keymap("n", maps.nextSubst, function()
+	keymap("n", maps.nextSubstitutionInHistory, function()
 		if state.historyPosition == #state.popupHistory + 1 then return end -- already at present
 		state.historyPosition = state.historyPosition + 1
 		local content = state.historyPosition == #state.popupHistory + 1 and state.popupPresentContent
@@ -290,8 +290,8 @@ local function createKeymaps()
 			("- [%s] abort"):format(maps.abort),
 			("- [%s] confirm"):format(maps.confirm),
 			("- [%s] confirm (insert mode)"):format(maps.insertModeConfirm),
-			("- [%s] next in history"):format(maps.nextSubst),
-			("- [%s] previous in history"):format(maps.prevSubst),
+			("- [%s] previous in history"):format(maps.prevSubstitutionInHistory),
+			("- [%s] next in history"):format(maps.nextSubstitutionInHistory),
 			("- [%s] toggle `--fixed-strings`"):format(maps.toggleFixedStrings),
 			("- [%s] toggle `--ignore-case`"):format(maps.toggleIgnoreCase),
 			("- [%s] open at regex101"):format(maps.openAtRegex101),