feat: separate keymap for n/v mode

Author: chenasraf

.editorconfig

@@ -7,3 +7,4 @@ trim_trailing_whitespace = true
 
 [*.md]
 trim_trailing_whitespace = false
+

doc/text-transform.txt

@@ -7,12 +7,15 @@ Your plugin configuration with its default values.
 Default values:
 >
   TextTransform.options = {
-      -- Prints useful logs about what event are triggered, and reasons actions are executed.
-      debug = false,
-      -- Keymap to trigger the transform.
-      keymap = {
-          "<Leader>~",
-      },
+    -- Prints useful logs about what event are triggered, and reasons actions are executed.
+    debug = false,
+    -- Keymap to trigger the transform.
+    keymap = {
+      -- Normal mode keymap.
+      ["n"] = "<Leader>~",
+      -- Visual mode keymap.
+      ["v"] = "<Leader>~",
+    },
   }
 
 <

lua/text-transform/config.lua

@@ -5,12 +5,15 @@ local TextTransform = {}
 --- Default values:
 ---@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section)
 TextTransform.options = {
-    -- Prints useful logs about what event are triggered, and reasons actions are executed.
-    debug = false,
-    -- Keymap to trigger the transform.
-    keymap = {
-        "<Leader>~",
-    },
+  -- Prints useful logs about what event are triggered, and reasons actions are executed.
+  debug = false,
+  -- Keymap to trigger the transform.
+  keymap = {
+    -- Normal mode keymap.
+    ["n"] = "<Leader>~",
+    -- Visual mode keymap.
+    ["v"] = "<Leader>~",
+  },
 }
 
 --- Define your text-transform setup.
@@ -19,22 +22,40 @@ TextTransform.options = {
 ---
 ---@usage `require("text-transform").setup()` (add `{}` with your |TextTransform.options| table)
 function TextTransform.setup(options)
-    options = options or {}
-
-    TextTransform.options = vim.tbl_deep_extend("keep", options, TextTransform.options)
-    -- use input from current word in editor
-    vim.cmd("amenu Transforms.&camelCase :lua ReplaceCurrentWord(CamelCase)<CR>")
-    vim.cmd("amenu Transforms.&snake_case :lua ReplaceCurrentWord(SnakeCase)<CR>")
-    vim.cmd("amenu Transforms.&PascalCase :lua ReplaceCurrentWord(PascalCase)<CR>")
-    vim.cmd("amenu Transforms.&kebab-case :lua ReplaceCurrentWord(KebabCase)<CR>")
-    vim.cmd("amenu Transforms.&dot\\.case :lua ReplaceCurrentWord(DotCase)<CR>")
-    vim.cmd("amenu Transforms.&Title\\ Case :lua ReplaceCurrentWord(TitleCase)<CR>")
-
-    for kmap in TextTransform.options.keymap do
-        vim.keymap.set({ "n", "v" }, kmap, "<cmd>popup Transforms<CR>", { silent = true })
-    end
-
-    return TextTransform.options
+  options = options or {}
+
+  TextTransform.options = vim.tbl_deep_extend("keep", options, TextTransform.options)
+
+  -- use input from current word in editor
+  vim.cmd("amenu TransformsSelection.&camelCase :lua ReplaceCurrentSelection(CamelCase)<CR>")
+  vim.cmd("amenu TransformsSelection.&snake_case :lua ReplaceCurrentSelection(SnakeCase)<CR>")
+  vim.cmd("amenu TransformsSelection.&PascalCase :lua ReplaceCurrentSelection(PascalCase)<CR>")
+  vim.cmd("amenu TransformsSelection.&kebab-case :lua ReplaceCurrentSelection(KebabCase)<CR>")
+  vim.cmd("amenu TransformsSelection.&dot\\.case :lua ReplaceCurrentSelection(DotCase)<CR>")
+  vim.cmd("amenu TransformsSelection.&Title\\ Case :lua ReplaceCurrentSelection(TitleCase)<CR>")
+
+  -- use input from current word in editor
+  vim.cmd("amenu TransformsWord.&camelCase :lua ReplaceCurrentWord(CamelCase)<CR>")
+  vim.cmd("amenu TransformsWord.&snake_case :lua ReplaceCurrentWord(SnakeCase)<CR>")
+  vim.cmd("amenu TransformsWord.&PascalCase :lua ReplaceCurrentWord(PascalCase)<CR>")
+  vim.cmd("amenu TransformsWord.&kebab-case :lua ReplaceCurrentWord(KebabCase)<CR>")
+  vim.cmd("amenu TransformsWord.&dot\\.case :lua ReplaceCurrentWord(DotCase)<CR>")
+  vim.cmd("amenu TransformsWord.&Title\\ Case :lua ReplaceCurrentWord(TitleCase)<CR>")
+
+  vim.keymap.set(
+    "n",
+    TextTransform.options.keymap.n,
+    "<cmd>popup TransformsWord<CR>",
+    { silent = true }
+  )
+  vim.keymap.set(
+    "v",
+    TextTransform.options.keymap.v,
+    "<cmd>popup TransformsSelection<CR>",
+    { silent = true }
+  )
+
+  return TextTransform.options
 end
 
 return TextTransform

lua/text-transform/init.lua

@@ -3,37 +3,37 @@ local TextTransform = {}
 
 -- Toggle the plugin by calling the `enable`/`disable` methods respectively.
 function TextTransform.toggle()
-    -- when the config is not set to the global object, we set it
-    if _G.TextTransform.config == nil then
-        _G.TextTransform.config = require("text-transform.config").options
-    end
+  -- when the config is not set to the global object, we set it
+  if _G.TextTransform.config == nil then
+    _G.TextTransform.config = require("text-transform.config").options
+  end
 
-    _G.TextTransform.state = M.toggle()
+  _G.TextTransform.state = M.toggle()
 end
 
 -- starts TextTransform and set internal functions and state.
 function TextTransform.enable()
-    if _G.TextTransform.config == nil then
-        _G.TextTransform.config = require("text-transform.config").options
-    end
+  if _G.TextTransform.config == nil then
+    _G.TextTransform.config = require("text-transform.config").options
+  end
 
-    local state = M.enable()
+  local state = M.enable()
 
-    if state ~= nil then
-        _G.TextTransform.state = state
-    end
+  if state ~= nil then
+    _G.TextTransform.state = state
+  end
 
-    return state
+  return state
 end
 
 -- disables TextTransform and reset internal functions and state.
 function TextTransform.disable()
-    _G.TextTransform.state = M.disable()
+  _G.TextTransform.state = M.disable()
 end
 
 -- setup TextTransform options and merge them with user provided ones.
 function TextTransform.setup(opts)
-    _G.TextTransform.config = require("text-transform.config").setup(opts)
+  _G.TextTransform.config = require("text-transform.config").setup(opts)
 end
 
 _G.TextTransform = TextTransform

lua/text-transform/main.lua

@@ -5,45 +5,45 @@ local TextTransform = {}
 
 -- state
 local S = {
-    -- Boolean determining if the plugin is enabled or not.
-    enabled = false,
+  -- Boolean determining if the plugin is enabled or not.
+  enabled = false,
 }
 
 ---Toggle the plugin by calling the `enable`/`disable` methods respectively.
 ---@private
 function TextTransform.toggle()
-    if S.enabled then
-        return TextTransform.disable()
-    end
+  if S.enabled then
+    return TextTransform.disable()
+  end
 
-    return TextTransform.enable()
+  return TextTransform.enable()
 end
 
 ---Initializes the plugin.
 ---@private
 function TextTransform.enable()
-    if S.enabled then
-        return S
-    end
+  if S.enabled then
+    return S
+  end
 
-    S.enabled = true
+  S.enabled = true
 
-    return S
+  return S
 end
 
 ---Disables the plugin and reset the internal state.
 ---@private
 function TextTransform.disable()
-    if not S.enabled then
-        return S
-    end
+  if not S.enabled then
+    return S
+  end
 
-    -- reset the state
-    S = {
-        enabled = false,
-    }
+  -- reset the state
+  S = {
+    enabled = false,
+  }
 
-    return S
+  return S
 end
 
 return TextTransform

lua/text-transform/util/debug.lua

@@ -7,26 +7,26 @@ local D = {}
 ---@param ... any: the arguments of the formatted string.
 ---@private
 function D.log(scope, str, ...)
-    if _G.TextTransform.config ~= nil and not _G.TextTransform.config.debug then
-        return
-    end
-
-    local info = debug.getinfo(2, "Sl")
-    local line = ""
-
-    if info then
-        line = "L" .. info.currentline
-    end
-
-    print(
-        string.format(
-            "[text-transform:%s %s in %s] > %s",
-            os.date("%H:%M:%S"),
-            line,
-            scope,
-            string.format(str, ...)
-        )
+  if _G.TextTransform.config ~= nil and not _G.TextTransform.config.debug then
+    return
+  end
+
+  local info = debug.getinfo(2, "Sl")
+  local line = ""
+
+  if info then
+    line = "L" .. info.currentline
+  end
+
+  print(
+    string.format(
+      "[text-transform:%s %s in %s] > %s",
+      os.date("%H:%M:%S"),
+      line,
+      scope,
+      string.format(str, ...)
     )
+  )
 end
 
 ---prints the table if debug is true.
@@ -35,27 +35,27 @@ end
 ---@param indent number?: the default indent value, starts at 0.
 ---@private
 function D.tprint(table, indent)
-    if _G.TextTransform.config ~= nil and not _G.TextTransform.config.debug then
-        return
-    end
-
-    if not indent then
-        indent = 0
-    end
-
-    for k, v in pairs(table) do
-        local formatting = string.rep("  ", indent) .. k .. ": "
-        if type(v) == "table" then
-            print(formatting)
-            D.tprint(v, indent + 1)
-        elseif type(v) == "boolean" then
-            print(formatting .. tostring(v))
-        elseif type(v) == "function" then
-            print(formatting .. "FUNCTION")
-        else
-            print(formatting .. v)
-        end
+  if _G.TextTransform.config ~= nil and not _G.TextTransform.config.debug then
+    return
+  end
+
+  if not indent then
+    indent = 0
+  end
+
+  for k, v in pairs(table) do
+    local formatting = string.rep("  ", indent) .. k .. ": "
+    if type(v) == "table" then
+      print(formatting)
+      D.tprint(v, indent + 1)
+    elseif type(v) == "boolean" then
+      print(formatting .. tostring(v))
+    elseif type(v) == "function" then
+      print(formatting .. "FUNCTION")
+    else
+      print(formatting .. v)
     end
+  end
 end
 
 return D