barrett/canola.nvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

feat: disable preview for large files (#511)

Browse source 
* feat: disable preview for large files

fix: update oil.PreviewWindowConfig

* refactor: remove unnecessary shim in config.lua

* refactor: revert changes to shim

---------

Co-authored-by: Steve Walker <65963536+etherswangel@users.noreply.github.com>
Co-authored-by: Steven Arcangeli <506791+stevearc@users.noreply.github.com>
This commit is contained in:
Steve Walker 2024-11-13 00:24:39 +08:00 • committed by GitHub
parent 50c4bd4ee2
commit c23fe08e05
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 15 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -271,6 +271,8 @@ require("oil").setup({
preview_win = { preview_win = {
-- Whether the preview window is automatically updated when the cursor is moved -- Whether the preview window is automatically updated when the cursor is moved
update_on_cursor_moved = true, update_on_cursor_moved = true,
-- Maximum file size in megabytes to preview
max_file_size_mb = 100,
}, },
-- Configuration for the floating action confirmation window -- Configuration for the floating action confirmation window
confirmation = { confirmation = {

2
doc/oil.txt
View file

@ -156,6 +156,8 @@ CONFIG *oil-confi
preview_win = { preview_win = {
-- Whether the preview window is automatically updated when the cursor is moved -- Whether the preview window is automatically updated when the cursor is moved
update_on_cursor_moved = true, update_on_cursor_moved = true,
-- Maximum file size in megabytes to preview
max_file_size_mb = 100,
}, },
-- Configuration for the floating action confirmation window -- Configuration for the floating action confirmation window
confirmation = { confirmation = {

4
lua/oil/config.lua
View file

@ -141,6 +141,8 @@ local default_config = {
preview_win = { preview_win = {
-- Whether the preview window is automatically updated when the cursor is moved -- Whether the preview window is automatically updated when the cursor is moved
update_on_cursor_moved = true, update_on_cursor_moved = true,
-- Maximum file size in megabytes to preview
max_file_size_mb = 100,
}, },
-- Configuration for the floating action confirmation window -- Configuration for the floating action confirmation window
confirmation = { confirmation = {
@ -323,11 +325,13 @@ local M = {}
---@class (exact) oil.PreviewWindowConfig ---@class (exact) oil.PreviewWindowConfig
---@field update_on_cursor_moved boolean ---@field update_on_cursor_moved boolean
---@field max_file_size_mb number
---@class (exact) oil.ConfirmationWindowConfig : oil.WindowConfig ---@class (exact) oil.ConfirmationWindowConfig : oil.WindowConfig
---@class (exact) oil.SetupPreviewWindowConfig ---@class (exact) oil.SetupPreviewWindowConfig
---@field update_on_cursor_moved? boolean Whether the preview window is automatically updated when the cursor is moved ---@field update_on_cursor_moved? boolean Whether the preview window is automatically updated when the cursor is moved
---@field max_file_size_mb? number Maximum file size in megabytes to preview
---@class (exact) oil.SetupConfirmationWindowConfig : oil.SetupWindowConfig ---@class (exact) oil.SetupConfirmationWindowConfig : oil.SetupWindowConfig

7
lua/oil/init.lua
View file

@ -452,6 +452,13 @@ M.open_preview = function(opts, callback)
if not entry then if not entry then
return finish("Could not find entry under cursor") return finish("Could not find entry under cursor")
end end
if entry.meta ~= nil and entry.meta.stat ~= nil then
if entry.meta.stat.size >= config.preview_win.max_file_size_mb * 1e6 then
return finish(
"File over " .. config.preview_win.max_file_size_mb .. "MB is too large to preview"
)
end
end
local entry_title = entry.name local entry_title = entry.name
if entry.type == "directory" then if entry.type == "directory" then
entry_title = entry_title .. "/" entry_title = entry_title .. "/"