Add option to customize default image name

See #355

Author: epwalsh

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Added configuration option `image_name_func: (fun(): string)|?` for customizing the default image name/prefix when pasting images via `:ObsidianPasteImg`.
 - Added client method `Client:current_note()` to get the note corresponding to the current buffer.
 - Added note method `Note.add_field(key: string, value: any)` to add/update an additional field in the frontmatter.
 - Added note method `Note.get_field(key: string)`.

README.md

@@ -316,6 +316,12 @@ This is a complete list of all of the options that can be passed to `require("ob
     return tostring(os.time()) .. "-" .. suffix
   end,
 
+  -- Optional, customize the default name or prefix when pasting images via `:ObsidianPasteImg`.
+  image_name_func = function()
+    -- Prefix image names with timestamp.
+    return string.format("%s-", os.time())
+  end,
+
   -- Optional, boolean or a function that takes a filename and returns a boolean.
   -- `true` indicates that you don't want obsidian.nvim to manage frontmatter.
   disable_frontmatter = false,

lua/obsidian/commands/paste_img.lua

@@ -9,7 +9,13 @@ return function(client, data)
     img_folder = client.dir / client.opts.attachments.img_folder
   end
 
-  local path = paste_img(data.args, img_folder)
+  ---@type string|?
+  local default_name
+  if client.opts.image_name_func then
+    default_name = client.opts.image_name_func()
+  end
+
+  local path = paste_img(data.args, img_folder, default_name)
 
   if path ~= nil then
     util.insert_text(client.opts.attachments.img_text_func(client, path))

lua/obsidian/config.lua

@@ -11,9 +11,10 @@ local config = {}
 ---@field log_level integer
 ---@field notes_subdir string|?
 ---@field templates obsidian.config.TemplateOpts
----@field note_id_func function|?
----@field follow_url_func function|?
----@field note_frontmatter_func function|?
+---@field note_id_func (fun(title: string): string)|?
+---@field follow_url_func fun(url: string)|?
+---@field image_name_func (fun(): string)|?
+---@field note_frontmatter_func fun(note: obsidian.Note)|?
 ---@field disable_frontmatter (fun(fname: string?): boolean)|boolean|?
 ---@field backlinks obsidian.config.LocationListOpts
 ---@field tags obsidian.config.LocationListOpts

lua/obsidian/img_paste.lua

@@ -28,7 +28,8 @@ local function get_clip_check_command()
   return check_cmd
 end
 
----Check if clipboard contains image data.
+--- Check if clipboard contains image data.
+---
 ---@return boolean
 local function clipboard_is_img()
   local content = {}
@@ -49,8 +50,9 @@ local function clipboard_is_img()
   end
 end
 
----Save image from clipboard to `path`.
+--- Save image from clipboard to `path`.
 ---@param path string
+---
 ---@return boolean|integer|? result
 local function save_clipboard_image(path)
   local this_os = util.get_os()
@@ -84,15 +86,17 @@ end
 
 ---@param fname string|?
 ---@param default_dir Path|string
+---@param default_name string|?
+---
 ---@return Path|? image_path the absolute path to the image file
-M.paste_img = function(fname, default_dir)
+M.paste_img = function(fname, default_dir, default_name)
   if not clipboard_is_img() then
     log.err "There is no image data in the clipboard"
     return
   else
     -- Get filename to save to.
     if fname == "" then
-      fname = vim.fn.input { prompt = "Enter file name: " }
+      fname = vim.fn.input { prompt = "Enter file name: ", default = default_name }
     end
 
     if fname == "" then