Add opts.follow_img_func option

This adds the ability to preview images on Mac OS using `qlmanage`.
See the example in the README. (#411)

See also #660.

Author: epwalsh

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+
+- Added `opts.follow_img_func` option for customizing how to handle image paths.
+
 ## [v3.9.0](https://github.com/epwalsh/obsidian.nvim/releases/tag/v3.9.0) - 2024-07-11
 
 ### Added

README.md

@@ -400,6 +400,15 @@ This is a complete list of all of the options that can be passed to `require("ob
     -- vim.cmd(':silent exec "!start ' .. url .. '"') -- Windows
   end,
 
+  -- Optional, by default when you use `:ObsidianFollowLink` on a link to an image
+  -- file it will be ignored but you can customize this behavior here.
+  ---@param img string
+  follow_url_func = function(img)
+    vim.fn.jobstart { "qlmanage", "-p", img }  -- Mac OS quick look preview
+    -- vim.fn.jobstart({"xdg-open", url})  -- linux
+    -- vim.cmd(':silent exec "!start ' .. url .. '"') -- Windows
+  end,
+
   -- Optional, set to true if you use the Obsidian Advanced URI plugin.
   -- https://github.com/Vinzent03/obsidian-advanced-uri
   use_advanced_uri = false,

lua/obsidian/client.lua

@@ -875,6 +875,15 @@ Client.follow_link_async = function(self, link, opts)
         return self:open_note(res.note, { line = res.line, col = res.col, open_strategy = opts.open_strategy })
       end
 
+      if util.is_img(res.location) then
+        if self.opts.follow_img_func ~= nil then
+          self.opts.follow_img_func(res.location)
+        else
+          log.warn "This looks like an image path. You can customize the behavior of images with the 'follow_img_func' option."
+        end
+        return
+      end
+
       if res.link_type == search.RefTypes.Wiki or res.link_type == search.RefTypes.WikiWithAlias then
         -- Prompt to create a new note.
         if util.confirm("Create new note '" .. res.location .. "'?") then

lua/obsidian/config.lua

@@ -16,6 +16,7 @@ local config = {}
 ---@field markdown_link_func (fun(opts: {path: string, label: string, id: string|?}): string)
 ---@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|?

lua/obsidian/util.lua

@@ -193,6 +193,15 @@ util.is_url = function(s)
   end
 end
 
+util.is_img = function(s)
+  for _, suffix in ipairs { ".png", ".jpg", ".jpeg", ".heic", ".gif", ".svg", ".ico" } do
+    if vim.endswith(s, suffix) then
+      return true
+    end
+  end
+  return false
+end
+
 -- This function removes a single backslash within double square brackets
 util.unescape_single_backslash = function(text)
   return text:gsub("(%[%[[^\\]+)\\(%|[^\\]+]])", "%1%2")