Rename image_name_func to attachments.img_name_func

Author: epwalsh

CHANGELOG.md

@@ -11,6 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Added `opts.follow_img_func` option for customizing how to handle image paths.
 
+### Changed
+
+- Renamed `opts.image_name_func` to `opts.attachments.img_name_func`.
+
 ### Fixed
 
 - Fixed an edge case with collecting backlinks.

README.md

@@ -349,13 +349,6 @@ This is a complete list of all of the options that can be passed to `require("ob
   -- Either 'wiki' or 'markdown'.
   preferred_link_style = "wiki",
 
-  -- Optional, customize the default name or prefix when pasting images via `:ObsidianPasteImg`.
-  ---@return string
-  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,
@@ -528,6 +521,14 @@ This is a complete list of all of the options that can be passed to `require("ob
     -- If this is a relative path it will be interpreted as relative to the vault root.
     -- You can always override this per image by passing a full path to the command instead of just a filename.
     img_folder = "assets/imgs",  -- This is the default
+
+    -- Optional, customize the default name or prefix when pasting images via `:ObsidianPasteImg`.
+    ---@return string
+    img_name_func = function()
+      -- Prefix image names with timestamp.
+      return string.format("%s-", os.time())
+    end,
+
     -- A function that determines the text to insert in the note when pasting an image.
     -- It takes two arguments, the `obsidian.Client` and an `obsidian.Path` to the image file.
     -- This is the default implementation.

lua/obsidian/commands/paste_img.lua

@@ -11,8 +11,8 @@ return function(client, data)
 
   ---@type string|?
   local default_name
-  if client.opts.image_name_func then
-    default_name = client.opts.image_name_func()
+  if client.opts.attachments.img_name_func then
+    default_name = client.opts.attachments.img_name_func()
   end
 
   local path = paste_img {

lua/obsidian/config.lua

@@ -17,7 +17,6 @@ local config = {}
 ---@field preferred_link_style obsidian.config.LinkStyle
 ---@field follow_url_func fun(url: string)|?
 ---@field follow_img_func fun(img: string)|?
----@field image_name_func (fun(): string)|?
 ---@field note_frontmatter_func (fun(note: obsidian.Note): table)|?
 ---@field disable_frontmatter (fun(fname: string?): boolean)|boolean|?
 ---@field completion obsidian.config.CompletionOpts
@@ -208,6 +207,11 @@ config.ClientOpts.normalize = function(opts, defaults)
     opts.templates.subdir = nil
   end
 
+  if opts.image_name_func then
+    opts.attachments.img_name_func = opts.image_name_func
+    opts.image_name_func = nil
+  end
+
   --------------------------
   -- Merge with defaults. --
   --------------------------
@@ -465,6 +469,7 @@ end
 ---@class obsidian.config.AttachmentsOpts
 ---
 ---@field img_folder string Default folder to save images to, relative to the vault root.
+---@field img_name_func (fun(): string)|?
 ---@field img_text_func fun(client: obsidian.Client, path: obsidian.Path): string
 ---@field confirm_img_paste boolean Whether to confirm the paste or not. Defaults to true.
 config.AttachmentsOpts = {}