Skip to content

feat: add formatting options for file_history_panel #441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat: add formatting options for file_history_panel #441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ba89b73
feat: add formatting options as a list
protiumx Nov 21, 2023
1d133f2
docs: default config for file history pannel commit format
protiumx Nov 21, 2023
c45146c
test: all format components
protiumx Nov 21, 2023
53d2539
revert formatting
protiumx Dec 3, 2023
b39df42
test: monkey patch os.difftime to cover commit relative date
protiumx Dec 3, 2023
065435b
style format
protiumx Dec 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion doc/diffview_defaults.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ DEFAULT CONFIG *diffview.defaults*
},
view = {
-- Configure the layout and behavior of different types of views.
-- Available layouts:
-- Available layouts:
-- 'diff1_plain'
-- |'diff2_horizontal'
-- |'diff2_vertical'
Expand Down Expand Up @@ -74,6 +74,16 @@ DEFAULT CONFIG *diffview.defaults*
multi_file = {},
},
},
commit_format = {
'status',
'stats',
'hash',
'reflog',
'ref',
'subject',
'author',
'date',
},
win_config = { -- See |diffview-config-win_config|
position = "bottom",
height = 16,
Expand Down
14 changes: 12 additions & 2 deletions lua/diffview/config.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,16 @@ M.defaults = {
multi_file = {},
},
},
commit_format = {
'status',
'stats',
'hash',
'reflog',
'ref',
'subject',
'author',
'date',
},
win_config = {
position = "bottom",
height = 16,
Expand Down Expand Up @@ -349,7 +359,7 @@ function M.get_log_options(single_file, t, vcs)
local log_options

if single_file then
log_options = M._config.file_history_panel.log_options[vcs].single_file
log_options = M._config.file_history_panel.log_options[vcs].single_file
else
log_options = M._config.file_history_panel.log_options[vcs].multi_file
end
Expand Down Expand Up @@ -500,7 +510,7 @@ function M.setup(user_config)
local old_win_config_spec = { "position", "width", "height" }
for _, panel_name in ipairs({ "file_panel", "file_history_panel" }) do
local panel_config = M._config[panel_name]
---@cast panel_config table
---@cast panel_config table
local notified = false

for _, option in ipairs(old_win_config_spec) do
Expand Down
175 changes: 104 additions & 71 deletions lua/diffview/scene/views/file_history/render.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,103 @@ local pl = utils.path

local cache = setmetatable({}, { __mode = "k" })

local formatters = {
---@type fun(comp:RenderComponent, entry:LogEntry, params:table)
status = function(comp, entry, _)
if entry.status then
comp:add_text(entry.status, hl.get_git_hl(entry.status))
else
comp:add_text("-", "DiffviewNonText")
end
end,

---@type fun(comp:RenderComponent, entry:LogEntry, params:table)
files = function(comp, entry, params)
if entry.single_file then return end

local s_num_files = tostring(params.max_num_files)

if entry.nulled then
comp:add_text(utils.str_center_pad("empty", #s_num_files + 7), "DiffviewFilePanelCounter")
else
comp:add_text(
fmt(
" %s file%s",
utils.str_left_pad(tostring(#entry.files), #s_num_files),
#entry.files > 1 and "s" or " "
),
"DiffviewFilePanelCounter"
)
end
end,

---@type fun(comp:RenderComponent, entry:LogEntry, params:table)
hash = function(comp, entry, _)
if entry.commit.hash then comp:add_text(" " .. entry.commit.hash:sub(1, 8), "DiffviewHash") end
end,

---@type fun(comp:RenderComponent, entry:LogEntry, params:table)
stats = function(comp, entry, params)
if params.max_len_stats == -1 then return end

local adds = { "-", "DiffviewNonText" }
local dels = { "-", "DiffviewNonText" }

if entry.stats and entry.stats.additions then
adds = { tostring(entry.stats.additions), "DiffviewFilePanelInsertions" }
end

if entry.stats and entry.stats.deletions then
dels = { tostring(entry.stats.deletions), "DiffviewFilePanelDeletions" }
end

comp:add_text(" | ", "DiffviewNonText")
comp:add_text(unpack(adds))
comp:add_text(string.rep(" ", params.max_len_stats - (#adds[1] + #dels[1])))
comp:add_text(unpack(dels))
comp:add_text(" |", "DiffviewNonText")
end,

---@type fun(comp:RenderComponent, entry:LogEntry, params:table)
reflog = function(comp, entry, _)
local reflog_selector = (entry.commit --[[@as GitCommit ]]).reflog_selector
if reflog_selector then
comp:add_text((" %s"):format(reflog_selector), "DiffviewReflogSelector")
end
end,

---@type fun(comp:RenderComponent, entry:LogEntry, params:table)
ref = function(comp, entry, _)
if entry.commit.ref_names then
comp:add_text((" (%s)"):format(entry.commit.ref_names), "DiffviewReference")
end
end,

---@type fun(comp:RenderComponent, entry:LogEntry, params:table)
subject = function(comp, entry, params)
local subject = utils.str_trunc(entry.commit.subject, 72)
if subject == "" then subject = "[empty message]" end
comp:add_text(
" " .. subject,
params.panel.cur_item[1] == entry and "DiffviewFilePanelSelected"
or "DiffviewFilePanelFileName"
)
end,

---@type fun(comp:RenderComponent, entry:LogEntry, params:table)
author = function(comp, entry, _) comp:add_text(" " .. entry.commit.author) end,

---@type fun(comp:RenderComponent, entry:LogEntry, params:table)
date = function(comp, entry, _)
-- 3 months
local date = (
os.difftime(os.time(), entry.commit.time) > 60 * 60 * 24 * 30 * 3 and entry.commit.iso_date
or entry.commit.rel_date
)
comp:add_text(" " .. date, "DiffviewFilePanelPath")
end,
}

---@param comp RenderComponent
---@param files FileEntry[]
local function render_files(comp, files)
Expand Down Expand Up @@ -88,79 +185,13 @@ local function render_entries(panel, parent, entries, updating)
comp:add_text((entry.folded and c.signs.fold_closed or c.signs.fold_open) .. " ", "CursorLineNr")
end

if entry.status then
comp:add_text(entry.status, hl.get_git_hl(entry.status))
else
comp:add_text("-", "DiffviewNonText")
end

if not entry.single_file then
local s_num_files = tostring(max_num_files)

if entry.nulled then
comp:add_text(utils.str_center_pad("empty", #s_num_files + 7), "DiffviewFilePanelCounter")
for format in c.file_history_panel.commit_format do
local fn = formatters[format]
if fn then
fn(comp, entry, { max_len_stats, max_num_files, panel })
else
comp:add_text(
fmt(
" %s file%s",
utils.str_left_pad(tostring(#entry.files), #s_num_files),
#entry.files > 1 and "s" or " "
),
"DiffviewFilePanelCounter"
)
end
end

if max_len_stats ~= -1 then
local adds = { "-", "DiffviewNonText" }
local dels = { "-", "DiffviewNonText" }

if entry.stats and entry.stats.additions then
adds = { tostring(entry.stats.additions), "DiffviewFilePanelInsertions" }
end

if entry.stats and entry.stats.deletions then
dels = { tostring(entry.stats.deletions), "DiffviewFilePanelDeletions" }
logger:warn("[format] Unsopported commit format: " .. format)
end

comp:add_text(" | ", "DiffviewNonText")
comp:add_text(unpack(adds))
comp:add_text(string.rep(" ", max_len_stats - (#adds[1] + #dels[1])))
comp:add_text(unpack(dels))
comp:add_text(" |", "DiffviewNonText")
end

if entry.commit.hash then
comp:add_text(" " .. entry.commit.hash:sub(1, 8), "DiffviewHash")
end

if (entry.commit --[[@as GitCommit ]]).reflog_selector then
comp:add_text((" %s"):format((entry.commit --[[@as GitCommit ]]).reflog_selector), "DiffviewReflogSelector")
end

if entry.commit.ref_names then
comp:add_text((" (%s)"):format(entry.commit.ref_names), "DiffviewReference")
end

local subject = utils.str_trunc(entry.commit.subject, 72)

if subject == "" then
subject = "[empty message]"
end

comp:add_text(
" " .. subject,
panel.cur_item[1] == entry and "DiffviewFilePanelSelected" or "DiffviewFilePanelFileName"
)

if entry.commit then
-- 3 months
local date = (
os.difftime(os.time(), entry.commit.time) > 60 * 60 * 24 * 30 * 3
and entry.commit.iso_date
or entry.commit.rel_date
)
comp:add_text(" " .. entry.commit.author .. ", " .. date, "DiffviewFilePanelPath")
end

comp:ln()
Expand All @@ -186,6 +217,8 @@ local function prepare_panel_cache(panel)
end

return {
commit_formatters = formatters,

---@param panel FileHistoryPanel
file_history_panel = function(panel)
if not panel.render_data then
Expand Down
Loading