feat(img_paste): mimic Obsidian's behavior when pasting images. (#15)

* feat(img_paste): mimic Obsidian's behavior when pasting images.

This commit attempts to implement behavior similar to Obsidian's when
pasting an image, without requiring a name (#13).
It also includes a string validation for the filename. Although Obsidian
allows filenames to contain invalid characters, it warns you about
potential issues with links not working as a result.

* add default img_name_func, respects confirm and user define

* use vim.uri_encode to escape file path

* fix: use the builtin urlencode so that unicode path are readable

* fix: remove unneeded annotation

* fix: more descriptive CHANGELOG

---------

Co-authored-by: zizhou teng (n451) <[email protected]>
Co-authored-by: neo451 <[email protected]>

Author: ErlanRG

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Added default `image_name_func` similar to Obsidian's.
 - Added support `text/uri-list` to `ObsidianPasteImg`.
 
 ### Changed

README.md

@@ -564,11 +564,11 @@ This is a complete list of all of the options that can be passed to `require("ob
     -- 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`.
+    -- A function that determines 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())
+      return string.format("Pasted image %s", os.date "%Y%m%d%H%M%S")
     end,
 
     -- A function that determines the text to insert in the note when pasting an image.

lua/obsidian/config.lua

@@ -483,12 +483,12 @@ config.AttachmentsOpts = {}
 config.AttachmentsOpts.default = function()
   return {
     img_folder = "assets/imgs",
-    ---@param client obsidian.Client
-    ---@param path obsidian.Path the absolute path to the image file
-    ---@return string
     img_text_func = function(client, path)
       path = client:vault_relative_path(path) or path
-      return string.format("![%s](%s)", path.name, path)
+      return string.format("![%s](%s)", path.name, util.urlencode(tostring(path)))
+    end,
+    img_name_func = function()
+      return string.format("Pasted image %s", os.date "%Y%m%d%H%M%S")
     end,
     confirm_img_paste = true,
   }

lua/obsidian/img_paste.lua

@@ -115,7 +115,9 @@ M.paste_img = function(opts)
       fname = opts.default_name
     else
       fname = util.input("Enter file name: ", { default = opts.default_name, completion = "file" })
-      if not fname then
+      if fname == "" then
+        fname = opts.default_name
+      elseif not fname then
         log.warn "Paste aborted"
         return
       end
@@ -125,7 +127,10 @@ M.paste_img = function(opts)
   assert(fname)
   fname = util.strip_whitespace(fname)
 
-  if fname == "" then
+  -- Verify filename
+  if util.contains_invalid_characters(fname) then
+    log.warn "Links will not work with file names containing any of these characters in Obsidian: # ^ [ ] |"
+  elseif fname == "" then
     log.err "Invalid file name"
     return
   end

lua/obsidian/util.lua

@@ -1374,6 +1374,16 @@ util.buffer_is_empty = function(bufnr)
   end
 end
 
+--- Check if a string contains invalid characters.
+---
+--- @param fname string
+---
+--- @return boolean
+util.contains_invalid_characters = function(fname)
+  local invalid_chars = "#^%[%]|"
+  return string.find(fname, "[" .. invalid_chars .. "]") ~= nil
+end
+
 ---Check if a string is NaN
 ---
 ---@param v any