Feat: Adds More Information to Summary Panel (#100)
This MR adds more information into the summary view, including the MR author, created at date, merge status, draft status, conflicts, and pipeline status, among other things. This is configurable via the setup function.
This commit is contained in:
Harrison (Harry) Cramer
committed by
GitHub
GitHub
parent
88b9196a2e
commit
c4a3229f16
@@ -7,6 +7,8 @@ local job = require("gitlab.job")
|
||||
local u = require("gitlab.utils")
|
||||
local state = require("gitlab.state")
|
||||
local miscellaneous = require("gitlab.actions.miscellaneous")
|
||||
local pipeline = require("gitlab.actions.pipeline")
|
||||
|
||||
local M = {
|
||||
layout_visible = false,
|
||||
layout = nil,
|
||||
@@ -15,7 +17,46 @@ local M = {
|
||||
description_bufnr = nil,
|
||||
}
|
||||
|
||||
-- The function will render the MR description in a popup
|
||||
local title_popup_settings = {
|
||||
buf_options = {
|
||||
filetype = "markdown",
|
||||
},
|
||||
focusable = true,
|
||||
border = {
|
||||
style = "rounded",
|
||||
},
|
||||
}
|
||||
|
||||
local details_popup_settings = {
|
||||
buf_options = {
|
||||
filetype = "markdown",
|
||||
},
|
||||
focusable = true,
|
||||
border = {
|
||||
style = "rounded",
|
||||
text = {
|
||||
top = "Details",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
local description_popup_settings = {
|
||||
buf_options = {
|
||||
filetype = "markdown",
|
||||
},
|
||||
enter = true,
|
||||
focusable = true,
|
||||
border = {
|
||||
style = "rounded",
|
||||
text = {
|
||||
top = "Description",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
-- The function will render a popup containing the MR title and MR description, and optionally,
|
||||
-- any additional metadata that the user wants. The title and description are editable and
|
||||
-- can be changed via the local action keybinding, which also closes the popup
|
||||
M.summary = function()
|
||||
if M.layout_visible then
|
||||
M.layout:unmount()
|
||||
@@ -23,7 +64,11 @@ M.summary = function()
|
||||
return
|
||||
end
|
||||
|
||||
local layout, title_popup, description_popup = M.create_layout()
|
||||
local title = state.INFO.title
|
||||
local description_lines = M.build_description_lines()
|
||||
local info_lines = state.settings.info.enabled and M.build_info_lines() or nil
|
||||
|
||||
local layout, title_popup, description_popup, info_popup = M.create_layout(info_lines)
|
||||
|
||||
M.layout = layout
|
||||
M.layout_buf = layout.bufnr
|
||||
@@ -34,19 +79,16 @@ M.summary = function()
|
||||
M.layout_visible = false
|
||||
end
|
||||
|
||||
local currentBuffer = vim.api.nvim_get_current_buf()
|
||||
local title = state.INFO.title
|
||||
local description = state.INFO.description
|
||||
local lines = {}
|
||||
|
||||
for line in description:gmatch("[^\n]+") do
|
||||
table.insert(lines, line)
|
||||
table.insert(lines, "")
|
||||
end
|
||||
|
||||
vim.schedule(function()
|
||||
vim.api.nvim_buf_set_lines(currentBuffer, 0, -1, false, lines)
|
||||
vim.api.nvim_buf_set_lines(description_popup.bufnr, 0, -1, false, description_lines)
|
||||
vim.api.nvim_buf_set_lines(title_popup.bufnr, 0, -1, false, { title })
|
||||
|
||||
if info_popup then
|
||||
vim.api.nvim_buf_set_lines(info_popup.bufnr, 0, -1, false, info_lines)
|
||||
vim.api.nvim_set_option_value("modifiable", false, { buf = info_popup.bufnr })
|
||||
vim.api.nvim_set_option_value("readonly", false, { buf = info_popup.bufnr })
|
||||
end
|
||||
|
||||
state.set_popup_keymaps(
|
||||
description_popup,
|
||||
M.edit_summary,
|
||||
@@ -54,9 +96,76 @@ M.summary = function()
|
||||
{ cb = exit, action_before_close = true }
|
||||
)
|
||||
state.set_popup_keymaps(title_popup, M.edit_summary, nil, { cb = exit, action_before_close = true })
|
||||
|
||||
vim.api.nvim_set_current_buf(description_popup.bufnr)
|
||||
end)
|
||||
end
|
||||
|
||||
-- Builds a lua list of strings that contain the MR description
|
||||
M.build_description_lines = function()
|
||||
local description_lines = {}
|
||||
|
||||
local description = state.INFO.description
|
||||
for line in description:gmatch("[^\n]+") do
|
||||
table.insert(description_lines, line)
|
||||
table.insert(description_lines, "")
|
||||
end
|
||||
|
||||
return description_lines
|
||||
end
|
||||
|
||||
-- Builds a lua list of strings that contain metadata about the current MR. Only builds the
|
||||
-- lines that users include in their state.settings.info.fields list.
|
||||
M.build_info_lines = function()
|
||||
local info = state.INFO
|
||||
local options = {
|
||||
author = { title = "Author", content = "@" .. info.author.username .. " (" .. info.author.name .. ")" },
|
||||
created_at = { title = "Created", content = u.format_to_local(info.created_at, vim.fn.strftime("%z")) },
|
||||
updated_at = { title = "Updated", content = u.format_to_local(info.updated_at, vim.fn.strftime("%z")) },
|
||||
merge_status = { title = "Status", content = info.detailed_merge_status },
|
||||
draft = { title = "Draft", content = (info.draft and "Yes" or "No") },
|
||||
conflicts = { title = "Merge Conflicts", content = (info.has_conflicts and "Yes" or "No") },
|
||||
assignees = { title = "Assignees", content = u.make_readable_list(info.assignees, "name") },
|
||||
branch = { title = "Branch", content = info.source_branch },
|
||||
pipeline = {
|
||||
title = "Pipeline Status:",
|
||||
content = function()
|
||||
return pipeline.get_pipeline_status()
|
||||
end,
|
||||
},
|
||||
}
|
||||
|
||||
local longest_used = ""
|
||||
for _, v in ipairs(state.settings.info.fields) do
|
||||
local title = options[v].title
|
||||
if string.len(title) > string.len(longest_used) then
|
||||
longest_used = title
|
||||
end
|
||||
end
|
||||
|
||||
local function row_offset(row)
|
||||
local offset = string.len(longest_used) - string.len(row)
|
||||
return string.rep(" ", offset + 3)
|
||||
end
|
||||
|
||||
local lines = {}
|
||||
for _, v in ipairs(state.settings.info.fields) do
|
||||
local row = options[v]
|
||||
local line = "* " .. row.title .. row_offset(row.title)
|
||||
if type(row.content) == "function" then
|
||||
local content = row.content()
|
||||
if content ~= nil then
|
||||
line = line .. row.content()
|
||||
end
|
||||
else
|
||||
line = line .. row.content
|
||||
end
|
||||
table.insert(lines, line)
|
||||
end
|
||||
|
||||
return lines
|
||||
end
|
||||
|
||||
-- This function will PUT the new description to the Go server
|
||||
M.edit_summary = function()
|
||||
local description = u.get_buffer_text(M.description_bufnr)
|
||||
@@ -71,54 +180,52 @@ M.edit_summary = function()
|
||||
end)
|
||||
end
|
||||
|
||||
local top_popup = {
|
||||
buf_options = {
|
||||
filetype = "markdown",
|
||||
},
|
||||
focusable = true,
|
||||
border = {
|
||||
style = "rounded",
|
||||
text = {
|
||||
top = "Merge Request",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
local bottom_popup = {
|
||||
buf_options = {
|
||||
filetype = "markdown",
|
||||
},
|
||||
enter = true,
|
||||
focusable = true,
|
||||
border = {
|
||||
style = "rounded",
|
||||
},
|
||||
}
|
||||
|
||||
M.create_layout = function()
|
||||
local title_popup = Popup(top_popup)
|
||||
M.create_layout = function(info_lines)
|
||||
local title_popup = Popup(title_popup_settings)
|
||||
M.title_bufnr = title_popup.bufnr
|
||||
local description_popup = Popup(bottom_popup)
|
||||
local description_popup = Popup(description_popup_settings)
|
||||
M.description_bufnr = description_popup.bufnr
|
||||
local details_popup
|
||||
|
||||
local layout = Layout(
|
||||
{
|
||||
position = "50%",
|
||||
relative = "editor",
|
||||
size = {
|
||||
width = "90%",
|
||||
height = "70%",
|
||||
},
|
||||
},
|
||||
Layout.Box({
|
||||
Layout.Box(title_popup, { size = { height = 3 } }),
|
||||
Layout.Box(description_popup, { size = "100%" }),
|
||||
local internal_layout
|
||||
if state.settings.info.enabled then
|
||||
details_popup = Popup(details_popup_settings)
|
||||
if state.settings.info.horizontal then
|
||||
local longest_line = u.get_longest_string(info_lines)
|
||||
print(longest_line)
|
||||
internal_layout = Layout.Box({
|
||||
Layout.Box(title_popup, { size = 3 }),
|
||||
Layout.Box({
|
||||
Layout.Box(details_popup, { size = longest_line + 3 }),
|
||||
Layout.Box(description_popup, { grow = 1 }),
|
||||
}, { dir = "row", size = "100%" }),
|
||||
}, { dir = "col" })
|
||||
else
|
||||
internal_layout = Layout.Box({
|
||||
Layout.Box(title_popup, { size = 3 }),
|
||||
Layout.Box(description_popup, { grow = 1 }),
|
||||
Layout.Box(details_popup, { size = #info_lines + 3 }),
|
||||
}, { dir = "col" })
|
||||
end
|
||||
else
|
||||
internal_layout = Layout.Box({
|
||||
Layout.Box(title_popup, { size = 3 }),
|
||||
Layout.Box(description_popup, { grow = 1 }),
|
||||
}, { dir = "col" })
|
||||
)
|
||||
end
|
||||
|
||||
local layout = Layout({
|
||||
position = "50%",
|
||||
relative = "editor",
|
||||
size = {
|
||||
width = "95%",
|
||||
height = "95%",
|
||||
},
|
||||
}, internal_layout)
|
||||
|
||||
layout:mount()
|
||||
|
||||
return layout, title_popup, description_popup
|
||||
return layout, title_popup, description_popup, details_popup
|
||||
end
|
||||
|
||||
return M
|
||||
|
||||
Reference in New Issue
Block a user