feat: arguments in template function (#28)

* feat: pass arguments to template function

* test: add tests for template function with arguments

* docs: add template args

* fix: interpolate placeholders before passing args to template function

* test: add template args tests

* docs: rename placeholders to context

Author: hakonharnes

README.md

@@ -198,6 +198,14 @@ Templates in the plugin use placeholders that are dynamically replaced with the
 | `$LABEL`            | Figure label, generated from the file name, converted to lower-case and with spaces replaced by dashes. | `the-image` (from `the image.png`) |
 | `$CURSOR`           | Indicates where the cursor will be placed after insertion if `use_cursor_in_template` is true.          |                                    |
 
+Templates can also be defined using functions with the above placeholders available as function parameters:
+
+```lua
+template = function(context)
+  return "![" .. context.cursor .. "](" .. context.file_path .. ")"
+end
+```
+
 ## Drag and drop
 
 The drag and drop feature enables users to drag images from the web browser or file explorer into the terminal to automatically embed them, in **normal mode**. For this to work correctly, the following is required by the terminal emulator:

lua/img-clip/config.lua

@@ -97,7 +97,7 @@ M.options = {}
 ---@param key string
 ---@param opts? table The options passed to pasteImage function
 ---@return string | nil
-M.get_option = function(key, opts)
+M.get_option = function(key, opts, args)
   local ft = vim.bo.filetype
   local val
 
@@ -136,7 +136,7 @@ M.get_option = function(key, opts)
     return nil
   end
 
-  return type(val) == "function" and val() or val -- execute if function
+  return type(val) == "function" and val(args or {}) or val -- execute if function
 end
 
 function M.setup(opts)

lua/img-clip/markup.lua

@@ -61,11 +61,6 @@ end
 ---@param opts? table
 ---@return boolean
 function M.insert_markup(file_path, opts)
-  local template = config.get_option("template", opts)
-  if not template then
-    return false
-  end
-
   local file_name = vim.fn.fnamemodify(file_path, ":t")
   local file_name_no_ext = vim.fn.fnamemodify(file_path, ":t:r")
   local label = file_name_no_ext:gsub("%s+", "-"):lower()
@@ -80,6 +75,19 @@ function M.insert_markup(file_path, opts)
     file_path = fs.relpath(file_path, current_dir_path)
   end
 
+  -- pass args to template
+  local template_args = {
+    file_path = file_path,
+    file_name = file_name,
+    file_name_no_ext = file_name_no_ext,
+    cursor = "$CURSOR",
+    label = label,
+  }
+  local template = config.get_option("template", opts, template_args)
+  if not template then
+    return false
+  end
+
   -- url encode path
   if config.get_option("url_encode_path", opts) then
     file_path = M.url_encode(file_path)

tests/markup_spec.lua

@@ -89,5 +89,29 @@ describe("markup", function()
 
       assert.is_true(success)
     end)
+
+    it("inserts correct markup into a file when using template args", function()
+      config.setup({
+        default = {
+          template = function(context)
+            return context.cursor
+              .. " "
+              .. context.file_path
+              .. " "
+              .. context.file_name
+              .. " "
+              .. context.file_name_no_ext
+              .. " "
+              .. context.label
+          end,
+        },
+      })
+
+      local success = markup.insert_markup("/path/to/file.png")
+      local lines = vim.api.nvim_buf_get_lines(0, 0, -1, false)
+
+      assert.equal(" /path/to/file.png file.png file file", lines[2])
+      assert.is_true(success)
+    end)
   end)
 end)

vimdoc.md

@@ -198,6 +198,14 @@ Templates in the plugin use placeholders that are dynamically replaced with the
 | `$LABEL`            | Figure label, generated from the file name, converted to lower-case and with spaces replaced by dashes. | `the-image` (from `the image.png`) |
 | `$CURSOR`           | Indicates where the cursor will be placed after insertion if `use_cursor_in_template` is true.          |                                    |
 
+Templates can also be defined using functions with the above placeholders available as function parameters:
+
+```lua
+template = function(context)
+  return "![" .. context.cursor .. "](" .. context.file_path .. ")"
+end
+```
+
 ## Drag and drop
 
 The drag and drop feature enables users to drag images from the web browser or file explorer into the terminal to automatically embed them, in **normal mode**. For this to work correctly, the following is required by the terminal emulator: