feat: hijack image file patterns #56

README.md

@@ -6,6 +6,8 @@ It works wonderfully with Kitty + Tmux, and it handles painful things like rende
 at a given position in a buffer, scrolling, windows, etc.
 
 It has built-in Markdown and Neorg integrations that you can use right now.
+\
+It can also render image files as images when opened.
 
 https://github.com/3rd/image.nvim/assets/59587503/9a9a1792-6476-4d96-8b8e-d3cdd7f5759e
 
@@ -116,6 +118,7 @@ require("image").setup({
   window_overlap_clear_ft_ignore = { "cmp_menu", "cmp_docs", "" },
   editor_only_render_when_focused = false, -- auto show/hide images when the editor gains/looses focus
   tmux_show_only_in_active_window = false, -- auto show/hide images in the correct Tmux window (needs visual-activity off)
+  hijack_file_patterns = { "*.png", "*.jpg", "*.jpeg", "*.gif", "*.webp" }, -- render image files as images when opened
 })
 ```
 

lua/image/init.lua

@@ -26,6 +26,7 @@ local default_options = {
   window_overlap_clear_ft_ignore = { "cmp_menu", "cmp_docs", "" },
   editor_only_render_when_focused = false,
   tmux_show_only_in_active_window = false,
+  hijack_file_patterns = { "*.png", "*.jpg", "*.jpeg", "*.gif", "*.webp" },
 }
 
 ---@type State
@@ -266,6 +267,30 @@ api.setup = function(options)
       end,
     })
   end
+
+  -- hijack image filetypes
+  vim.api.nvim_create_autocmd({ "BufRead" }, {
+    group = group,
+    pattern = state.options.hijack_file_patterns,
+    callback = function(event)
+      local buf = event.buf
+      local win = vim.api.nvim_get_current_win()
+      local path = vim.api.nvim_buf_get_name(buf)
+
+      vim.bo[buf].modifiable = true
+      vim.api.nvim_buf_set_lines(buf, 0, -1, true, { "" })
+
+      vim.bo[buf].modifiable = false
+      vim.bo[buf].buftype = "nowrite"
+      vim.opt_local.colorcolumn = "0"
+      vim.opt_local.cursorline = false
+      vim.opt_local.number = false
+      vim.opt_local.signcolumn = "no"
+
+      local img = api.from_file(path, { window = win, buffer = buf })
+      img:render()
+    end,
+  })
 end
 
 local guard_setup = function()

lua/types.lua

@@ -37,6 +37,7 @@
 ---@field window_overlap_clear_ft_ignore? string[]
 ---@field editor_only_render_when_focused? boolean
 ---@field tmux_show_only_in_active_window? boolean
+---@field hijack_file_patterns? string[]
 
 ---@class BackendFeatures
 ---@field crop boolean