This MR is a #MAJOR breaking change to the plugin. While the plugin will continue to work for users with their existing settings, they will be informed of outdated configuration (diagnostics and signs have been simplified) the next time they open the reviewer. Fix: Trim trailing slash from custom URLs Update: .github/CONTRIBUTING.md, .github/ISSUE_TEMPLATE/bug_report.md Feat: Improve discussion tree toggling (#192) Fix: Toggle modified notes (#188) Fix: Toggle discussion nodes correctly Feat: Show Help keymap in discussion tree winbar Fix: Enable toggling nodes from the note body Fix: Enable toggling resolved status from child nodes Fix: Only try to show emoji popup on note nodes Feat: Add keymap for toggling tree type Fix: Disable tree type toggling in Notes Fix Multi Line Issues (Large Refactor) (#197) Fix: Multi-line discussions. The calculation of a range for a multiline comment has been consolidated and moved into the location.lua file. This does not attempt to fix diagnostics. Refactor: It refactors the discussions code to split hunk parsing and management into a separate module Fix: Don't allow comments on modified buffers #194 by preventing comments on the reviewer when using --imply-local and when the working tree is dirty entirely. Refactor: It introduces a new List class for data aggregation, filtering, etc. Fix: It removes redundant API calls and refreshes from the discussion pane Fix: Location provider (#198) Fix: add nil check for Diffview performance issue (#199) Fix: Switch Tabs During Comment Creation (#200) Fix: Check if file is modified (#201) Fix: Off-By-One Issue in Old SHA (#202) Fix: Rebuild Diagnostics + Signs (#203) Fix: Off-By-One Issue in New SHA (#205) Fix: Reviewer Jumps to wrong location (#206) BREAKING CHANGE: Changes configuration of diagnostics and signs in the setup call.
1052 lines
35 KiB
Lua
1052 lines
35 KiB
Lua
-- This module is responsible for the discussion tree. That includes things like
|
|
-- editing existing notes in the tree, replying to notes in the tree,
|
|
-- and marking discussions as resolved/unresolved.
|
|
local Split = require("nui.split")
|
|
local Popup = require("nui.popup")
|
|
local NuiTree = require("nui.tree")
|
|
local NuiLine = require("nui.line")
|
|
local job = require("gitlab.job")
|
|
local u = require("gitlab.utils")
|
|
local state = require("gitlab.state")
|
|
local reviewer = require("gitlab.reviewer")
|
|
local List = require("gitlab.utils.list")
|
|
local miscellaneous = require("gitlab.actions.miscellaneous")
|
|
local discussions_tree = require("gitlab.actions.discussions.tree")
|
|
local diffview_lib = require("diffview.lib")
|
|
local common = require("gitlab.indicators.common")
|
|
local signs = require("gitlab.indicators.signs")
|
|
local diagnostics = require("gitlab.indicators.diagnostics")
|
|
local winbar = require("gitlab.actions.discussions.winbar")
|
|
local help = require("gitlab.actions.help")
|
|
local emoji = require("gitlab.emoji")
|
|
|
|
local M = {
|
|
split_visible = false,
|
|
split = nil,
|
|
---@type number
|
|
split_bufnr = nil,
|
|
---@type Discussion[]
|
|
discussions = {},
|
|
---@type UnlinkedDiscussion[]
|
|
unlinked_discussions = {},
|
|
---@type EmojiMap
|
|
emojis = {},
|
|
---@type number
|
|
linked_bufnr = nil,
|
|
---@type number
|
|
unlinked_bufnr = nil,
|
|
---@type number
|
|
focused_bufnr = nil,
|
|
discussion_tree = nil,
|
|
}
|
|
|
|
---Makes API call to get the discussion data, store it in M.discussions and M.unlinked_discussions and call
|
|
---callback with data
|
|
---@param callback (fun(data: DiscussionData): nil)?
|
|
M.load_discussions = function(callback)
|
|
job.run_job("/mr/discussions/list", "POST", { blacklist = state.settings.discussion_tree.blacklist }, function(data)
|
|
M.discussions = data.discussions ~= vim.NIL and data.discussions or {}
|
|
M.unlinked_discussions = data.unlinked_discussions ~= vim.NIL and data.unlinked_discussions or {}
|
|
M.emojis = data.emojis or {}
|
|
if type(callback) == "function" then
|
|
callback(data)
|
|
end
|
|
end)
|
|
end
|
|
|
|
---Initialize everything for discussions like setup of signs, callbacks for reviewer, etc.
|
|
M.initialize_discussions = function()
|
|
signs.setup_signs()
|
|
reviewer.set_callback_for_file_changed(function()
|
|
M.refresh_view()
|
|
M.modifiable(false)
|
|
end)
|
|
reviewer.set_callback_for_reviewer_enter(function()
|
|
M.modifiable(false)
|
|
end)
|
|
reviewer.set_callback_for_reviewer_leave(function()
|
|
signs.clear_signs()
|
|
diagnostics.clear_diagnostics()
|
|
M.modifiable(true)
|
|
end)
|
|
end
|
|
|
|
--- Ensures that the both buffers in the reviewer are/not modifiable. Relevant if the user is using
|
|
--- the --imply-local setting
|
|
M.modifiable = function(bool)
|
|
local view = diffview_lib.get_current_view()
|
|
local a = view.cur_layout.a.file.bufnr
|
|
local b = view.cur_layout.b.file.bufnr
|
|
if a ~= nil and vim.api.nvim_buf_is_loaded(a) then
|
|
vim.api.nvim_buf_set_option(a, "modifiable", bool)
|
|
end
|
|
if b ~= nil and vim.api.nvim_buf_is_loaded(b) then
|
|
vim.api.nvim_buf_set_option(b, "modifiable", bool)
|
|
end
|
|
end
|
|
|
|
---Refresh discussion data, signs, diagnostics, and winbar with new data from API
|
|
--- and rebuild the entire view
|
|
M.refresh = function()
|
|
M.load_discussions(function()
|
|
M.refresh_view()
|
|
end)
|
|
end
|
|
|
|
--- Take existing data and refresh the diagnostics, the winbar, and the signs
|
|
M.refresh_view = function()
|
|
if state.settings.discussion_signs.enabled then
|
|
diagnostics.refresh_diagnostics(M.discussions)
|
|
end
|
|
if M.split_visible then
|
|
local linked_is_focused = M.linked_bufnr == M.focused_bufnr
|
|
winbar.update_winbar(M.discussions, M.unlinked_discussions, linked_is_focused and "Discussions" or "Notes")
|
|
end
|
|
end
|
|
|
|
---Toggle Discussions tree type between "simple" and "by_file_name"
|
|
---@param unlinked boolean True if selected view type is Notes (unlinked discussions)
|
|
M.toggle_tree_type = function(unlinked)
|
|
if unlinked then
|
|
u.notify("Toggling tree type is only possible in Discussions", vim.log.levels.INFO)
|
|
return
|
|
end
|
|
if state.settings.discussion_tree.tree_type == "simple" then
|
|
state.settings.discussion_tree.tree_type = "by_file_name"
|
|
else
|
|
state.settings.discussion_tree.tree_type = "simple"
|
|
end
|
|
M.rebuild_discussion_tree()
|
|
end
|
|
|
|
---Opens the discussion tree, sets the keybindings. It also
|
|
---creates the tree for notes (which are not linked to specific lines of code)
|
|
---@param callback function?
|
|
M.toggle = function(callback)
|
|
if M.split_visible then
|
|
M.close()
|
|
return
|
|
end
|
|
|
|
local split, linked_bufnr, unlinked_bufnr = M.create_split_and_bufs()
|
|
M.linked_bufnr = linked_bufnr
|
|
M.unlinked_bufnr = unlinked_bufnr
|
|
|
|
M.split = split
|
|
M.split_visible = true
|
|
M.split_bufnr = split.bufnr
|
|
split:mount()
|
|
M.switch_can_edit_bufs(true)
|
|
|
|
vim.api.nvim_buf_set_lines(split.bufnr, 0, -1, false, { "Loading data..." })
|
|
vim.api.nvim_set_option_value("filetype", "gitlab", { buf = M.split_bufnr })
|
|
vim.api.nvim_set_option_value("filetype", "gitlab", { buf = M.unlinked_bufnr })
|
|
vim.api.nvim_set_option_value("filetype", "gitlab", { buf = M.linked_bufnr })
|
|
|
|
local default_discussions = state.settings.discussion_tree.default_view == "discussions"
|
|
winbar.update_winbar({}, {}, default_discussions and "Discussions" or "Notes")
|
|
|
|
M.load_discussions(function()
|
|
if type(M.discussions) ~= "table" and type(M.unlinked_discussions) ~= "table" then
|
|
u.notify("No discussions or notes for this MR", vim.log.levels.WARN)
|
|
vim.api.nvim_buf_set_lines(split.bufnr, 0, -1, false, { "" })
|
|
return
|
|
end
|
|
|
|
local current_window = vim.api.nvim_get_current_win() -- Save user's current window in case they switched while content was loading
|
|
vim.api.nvim_set_current_win(M.split.winid)
|
|
|
|
M.rebuild_discussion_tree()
|
|
M.rebuild_unlinked_discussion_tree()
|
|
M.add_empty_titles({
|
|
{ M.linked_bufnr, M.discussions, "No Discussions for this MR" },
|
|
{ M.unlinked_bufnr, M.unlinked_discussions, "No Notes (Unlinked Discussions) for this MR" },
|
|
})
|
|
|
|
local default_buffer = default_discussions and M.linked_bufnr or M.unlinked_bufnr
|
|
vim.api.nvim_set_current_buf(default_buffer)
|
|
M.focused_bufnr = default_buffer
|
|
|
|
M.switch_can_edit_bufs(false)
|
|
M.refresh_view()
|
|
|
|
vim.api.nvim_set_current_win(current_window)
|
|
if type(callback) == "function" then
|
|
callback()
|
|
end
|
|
end)
|
|
end
|
|
|
|
-- Change between views in the discussion panel, either notes or discussions
|
|
local switch_view_type = function()
|
|
local change_to_unlinked = M.linked_bufnr == M.focused_bufnr
|
|
local new_bufnr = change_to_unlinked and M.unlinked_bufnr or M.linked_bufnr
|
|
vim.api.nvim_set_current_buf(new_bufnr)
|
|
winbar.update_winbar(M.discussions, M.unlinked_discussions, change_to_unlinked and "Notes" or "Discussions")
|
|
M.focused_bufnr = new_bufnr
|
|
end
|
|
|
|
-- Clears the discussion state and unmounts the split
|
|
M.close = function()
|
|
if M.split then
|
|
M.split:unmount()
|
|
end
|
|
M.split_visible = false
|
|
M.discussion_tree = nil
|
|
end
|
|
|
|
---Move to the discussion tree at the discussion from diagnostic on current line.
|
|
M.move_to_discussion_tree = function()
|
|
local current_line = vim.api.nvim_win_get_cursor(0)[1]
|
|
local d = vim.diagnostic.get(0, { namespace = diagnostics.diagnostics_namespace, lnum = current_line - 1 })
|
|
|
|
---Function used to jump to the discussion tree after the menu selection.
|
|
local jump_after_menu_selection = function(diagnostic)
|
|
---Function used to jump to the discussion tree after the discussion tree is opened.
|
|
local jump_after_tree_opened = function()
|
|
-- All diagnostics in `diagnotics_namespace` have diagnostic_id
|
|
local discussion_id = diagnostic.user_data.discussion_id
|
|
local discussion_node, line_number = M.discussion_tree:get_node("-" .. discussion_id)
|
|
if discussion_node == {} or discussion_node == nil then
|
|
u.notify("Discussion not found", vim.log.levels.WARN)
|
|
return
|
|
end
|
|
if not discussion_node:is_expanded() then
|
|
for _, child in ipairs(discussion_node:get_child_ids()) do
|
|
M.discussion_tree:get_node(child):expand()
|
|
end
|
|
discussion_node:expand()
|
|
end
|
|
M.discussion_tree:render()
|
|
vim.api.nvim_win_set_cursor(M.split.winid, { line_number, 0 })
|
|
vim.api.nvim_set_current_win(M.split.winid)
|
|
end
|
|
|
|
if not M.split_visible then
|
|
M.toggle(jump_after_tree_opened)
|
|
else
|
|
jump_after_tree_opened()
|
|
end
|
|
end
|
|
|
|
if #d == 0 then
|
|
u.notify("No diagnostics for this line", vim.log.levels.WARN)
|
|
return
|
|
elseif #d > 1 then
|
|
vim.ui.select(d, {
|
|
prompt = "Choose discussion to jump to",
|
|
format_item = function(diagnostic)
|
|
return diagnostic.message
|
|
end,
|
|
}, function(diagnostic)
|
|
if not diagnostic then
|
|
return
|
|
end
|
|
jump_after_menu_selection(diagnostic)
|
|
end)
|
|
else
|
|
jump_after_menu_selection(d[1])
|
|
end
|
|
end
|
|
|
|
-- The reply popup will mount in a window when you trigger it (settings.discussion_tree.reply) when hovering over a node in the discussion tree.
|
|
M.reply = function(tree)
|
|
local reply_popup = Popup(u.create_popup_state("Reply", state.settings.popup.reply))
|
|
local node = tree:get_node()
|
|
local discussion_node = M.get_root_node(tree, node)
|
|
local id = tostring(discussion_node.id)
|
|
reply_popup:mount()
|
|
state.set_popup_keymaps(reply_popup, M.send_reply(tree, id), miscellaneous.attach_file)
|
|
end
|
|
|
|
-- This function will send the reply to the Go API
|
|
M.send_reply = function(tree, discussion_id)
|
|
return function(text)
|
|
local body = { discussion_id = discussion_id, reply = text }
|
|
job.run_job("/mr/reply", "POST", body, function(data)
|
|
u.notify("Sent reply!", vim.log.levels.INFO)
|
|
M.add_reply_to_tree(tree, data.note, discussion_id)
|
|
M.load_discussions()
|
|
end)
|
|
end
|
|
end
|
|
|
|
-- This function (settings.discussion_tree.delete_comment) will trigger a popup prompting you to delete the current comment
|
|
M.delete_comment = function(tree, unlinked)
|
|
vim.ui.select({ "Confirm", "Cancel" }, {
|
|
prompt = "Delete comment?",
|
|
}, function(choice)
|
|
if choice == "Confirm" then
|
|
M.send_deletion(tree, unlinked)
|
|
end
|
|
end)
|
|
end
|
|
|
|
-- This function will actually send the deletion to Gitlab
|
|
-- when you make a selection, and re-render the tree
|
|
M.send_deletion = function(tree)
|
|
local current_node = tree:get_node()
|
|
|
|
local note_node = M.get_note_node(tree, current_node)
|
|
local root_node = M.get_root_node(tree, current_node)
|
|
local note_id = note_node.is_root and root_node.root_note_id or note_node.id
|
|
local body = { discussion_id = root_node.id, note_id = tonumber(note_id) }
|
|
job.run_job("/mr/comment", "DELETE", body, function(data)
|
|
u.notify(data.message, vim.log.levels.INFO)
|
|
if note_node.is_root then
|
|
-- Replace root node w/ current node's contents...
|
|
tree:remove_node("-" .. root_node.id)
|
|
else
|
|
tree:remove_node("-" .. note_id)
|
|
end
|
|
tree:render()
|
|
M.refresh()
|
|
end)
|
|
end
|
|
|
|
-- This function (settings.discussion_tree.edit_comment) will open the edit popup for the current comment in the discussion tree
|
|
M.edit_comment = function(tree, unlinked)
|
|
local edit_popup = Popup(u.create_popup_state("Edit Comment", state.settings.popup.edit))
|
|
local current_node = tree:get_node()
|
|
local note_node = M.get_note_node(tree, current_node)
|
|
local root_node = M.get_root_node(tree, current_node)
|
|
if note_node == nil or root_node == nil then
|
|
u.notify("Could not get root or note node", vim.log.levels.ERROR)
|
|
return
|
|
end
|
|
|
|
edit_popup:mount()
|
|
|
|
-- Gather all lines from immediate children that aren't note nodes
|
|
local lines = List.new(note_node:get_child_ids()):reduce(function(agg, child_id)
|
|
local child_node = tree:get_node(child_id)
|
|
if not child_node:has_children() then
|
|
local line = tree:get_node(child_id).text
|
|
table.insert(agg, line)
|
|
end
|
|
return agg
|
|
end, {})
|
|
|
|
local currentBuffer = vim.api.nvim_get_current_buf()
|
|
vim.api.nvim_buf_set_lines(currentBuffer, 0, -1, false, lines)
|
|
state.set_popup_keymaps(
|
|
edit_popup,
|
|
M.send_edits(tostring(root_node.id), tonumber(note_node.root_note_id or note_node.id), unlinked)
|
|
)
|
|
end
|
|
|
|
---This function sends the edited comment to the Go server
|
|
---@param discussion_id string
|
|
---@param note_id integer
|
|
---@param unlinked boolean
|
|
M.send_edits = function(discussion_id, note_id, unlinked)
|
|
return function(text)
|
|
local body = {
|
|
discussion_id = discussion_id,
|
|
note_id = note_id,
|
|
comment = text,
|
|
}
|
|
job.run_job("/mr/comment", "PATCH", body, function(data)
|
|
u.notify(data.message, vim.log.levels.INFO)
|
|
M.rebuild_discussion_tree()
|
|
if unlinked then
|
|
M.replace_text(M.unlinked_discussions, discussion_id, note_id, text)
|
|
M.rebuild_unlinked_discussion_tree()
|
|
else
|
|
M.replace_text(M.discussions, discussion_id, note_id, text)
|
|
M.rebuild_discussion_tree()
|
|
end
|
|
end)
|
|
end
|
|
end
|
|
|
|
-- This function (settings.discussion_tree.toggle_discussion_resolved) will toggle the resolved status of the current discussion and send the change to the Go server
|
|
M.toggle_discussion_resolved = function(tree)
|
|
local note = tree:get_node()
|
|
if note == nil then
|
|
return
|
|
end
|
|
|
|
-- Switch to the root node to enable toggling from child nodes and note bodies
|
|
if not note.resolvable and M.is_node_note(note) then
|
|
note = M.get_root_node(tree, note)
|
|
end
|
|
if note == nil then
|
|
return
|
|
end
|
|
|
|
local body = {
|
|
discussion_id = note.id,
|
|
resolved = not note.resolved,
|
|
}
|
|
|
|
job.run_job("/mr/discussions/resolve", "PUT", body, function(data)
|
|
u.notify(data.message, vim.log.levels.INFO)
|
|
M.redraw_resolved_status(tree, note, not note.resolved)
|
|
M.refresh()
|
|
end)
|
|
end
|
|
|
|
---Takes a node and returns the line where the note is positioned in the new SHA. If
|
|
---the line is not in the new SHA, returns nil
|
|
---@param node any
|
|
---@return number|nil
|
|
local function get_new_line(node)
|
|
if node.new_line == nil then
|
|
return nil
|
|
end
|
|
|
|
---@type GitlabLineRange|nil
|
|
local range = node.range
|
|
if range == nil then
|
|
if node.new_line == nil then
|
|
return nil
|
|
end
|
|
return node.new_line
|
|
end
|
|
|
|
local start_new_line, _ = common.parse_line_code(range.start.line_code)
|
|
return start_new_line
|
|
end
|
|
|
|
---Takes a node and returns the line where the note is positioned in the old SHA. If
|
|
---the line is not in the old SHA, returns nil
|
|
---@param node any
|
|
---@return number|nil
|
|
local function get_old_line(node)
|
|
if node.old_line == nil then
|
|
return nil
|
|
end
|
|
|
|
---@type GitlabLineRange|nil
|
|
local range = node.range
|
|
if range == nil then
|
|
return node.old_line
|
|
end
|
|
|
|
local _, start_old_line = common.parse_line_code(range.start.line_code)
|
|
return start_old_line
|
|
end
|
|
|
|
-- This function (settings.discussion_tree.jump_to_reviewer) will jump the cursor to the reviewer's location associated with the note. The implementation depends on the reviewer
|
|
M.jump_to_reviewer = function(tree)
|
|
local node = tree:get_node()
|
|
local root_node = M.get_root_node(tree, node)
|
|
if root_node == nil then
|
|
u.notify("Could not get discussion node", vim.log.levels.ERROR)
|
|
return
|
|
end
|
|
reviewer.jump(root_node.file_name, get_new_line(root_node), get_old_line(root_node))
|
|
M.refresh_view()
|
|
end
|
|
|
|
-- This function (settings.discussion_tree.jump_to_file) will jump to the file changed in a new tab
|
|
M.jump_to_file = function(tree)
|
|
local node = tree:get_node()
|
|
local root_node = M.get_root_node(tree, node)
|
|
if root_node == nil then
|
|
u.notify("Could not get discussion node", vim.log.levels.ERROR)
|
|
return
|
|
end
|
|
vim.cmd.tabnew()
|
|
local line_number = get_new_line(root_node) or get_old_line(root_node)
|
|
if line_number == nil then
|
|
line_number = 1
|
|
end
|
|
local bufnr = vim.fn.bufnr(root_node.filename)
|
|
if bufnr ~= -1 then
|
|
vim.cmd("buffer " .. bufnr)
|
|
vim.api.nvim_win_set_cursor(0, { line_number, 0 })
|
|
return
|
|
end
|
|
|
|
-- If buffer is not already open, open it
|
|
vim.cmd("edit " .. root_node.filename)
|
|
vim.api.nvim_win_set_cursor(0, { line_number, 0 })
|
|
end
|
|
|
|
-- This function (settings.discussion_tree.toggle_node) expands/collapses the current node and its children
|
|
M.toggle_node = function(tree)
|
|
local node = tree:get_node()
|
|
if node == nil then
|
|
return
|
|
end
|
|
|
|
-- Switch to the "note" node from "note_body" nodes to enable toggling discussions inside comments
|
|
if node.type == "note_body" then
|
|
node = tree:get_node(node:get_parent_id())
|
|
end
|
|
if node == nil then
|
|
return
|
|
end
|
|
|
|
local children = node:get_child_ids()
|
|
if node == nil then
|
|
return
|
|
end
|
|
if node:is_expanded() then
|
|
node:collapse()
|
|
if M.is_node_note(node) then
|
|
for _, child in ipairs(children) do
|
|
tree:get_node(child):collapse()
|
|
end
|
|
end
|
|
else
|
|
if M.is_node_note(node) then
|
|
for _, child in ipairs(children) do
|
|
tree:get_node(child):expand()
|
|
end
|
|
end
|
|
node:expand()
|
|
end
|
|
|
|
tree:render()
|
|
end
|
|
|
|
---@class ToggleNodesOptions
|
|
---@field toggle_resolved boolean Whether to toggle resolved discussions.
|
|
---@field toggle_unresolved boolean Whether to toggle unresolved discussions.
|
|
---@field keep_current_open boolean Whether to keep the current discussion open even if it should otherwise be closed.
|
|
|
|
---This function (settings.discussion_tree.toggle_nodes) expands/collapses all nodes and their children according to the opts.
|
|
---@param tree NuiTree
|
|
---@param opts ToggleNodesOptions
|
|
M.toggle_nodes = function(tree, unlinked, opts)
|
|
local current_node = tree:get_node()
|
|
if current_node == nil then
|
|
return
|
|
end
|
|
local root_node = M.get_root_node(tree, current_node)
|
|
for _, node in ipairs(tree:get_nodes()) do
|
|
if opts.toggle_resolved then
|
|
if
|
|
(unlinked and state.unlinked_discussion_tree.resolved_expanded)
|
|
or (not unlinked and state.discussion_tree.resolved_expanded)
|
|
then
|
|
M.collapse_recursively(tree, node, root_node, opts.keep_current_open, true)
|
|
else
|
|
M.expand_recursively(tree, node, true)
|
|
end
|
|
end
|
|
if opts.toggle_unresolved then
|
|
if
|
|
(unlinked and state.unlinked_discussion_tree.unresolved_expanded)
|
|
or (not unlinked and state.discussion_tree.unresolved_expanded)
|
|
then
|
|
M.collapse_recursively(tree, node, root_node, opts.keep_current_open, false)
|
|
else
|
|
M.expand_recursively(tree, node, false)
|
|
end
|
|
end
|
|
end
|
|
-- Reset states of resolved discussions after toggling
|
|
if opts.toggle_resolved then
|
|
if unlinked then
|
|
state.unlinked_discussion_tree.resolved_expanded = not state.unlinked_discussion_tree.resolved_expanded
|
|
else
|
|
state.discussion_tree.resolved_expanded = not state.discussion_tree.resolved_expanded
|
|
end
|
|
end
|
|
-- Reset states of unresolved discussions after toggling
|
|
if opts.toggle_unresolved then
|
|
if unlinked then
|
|
state.unlinked_discussion_tree.unresolved_expanded = not state.unlinked_discussion_tree.unresolved_expanded
|
|
else
|
|
state.discussion_tree.unresolved_expanded = not state.discussion_tree.unresolved_expanded
|
|
end
|
|
end
|
|
tree:render()
|
|
M.restore_cursor_position(tree, current_node, root_node)
|
|
end
|
|
|
|
---This function (settings.discussion_tree.collapse_recursively) collapses a node and its children.
|
|
---@param tree NuiTree
|
|
---@param node NuiTree.Node
|
|
---@param current_root_node NuiTree.Node The root node of the current node.
|
|
---@param keep_current_open boolean If true, the current node stays open, even if it should otherwise be collapsed.
|
|
---@param is_resolved boolean If true, collapse resolved discussions. If false, collapse unresolved discussions.
|
|
M.collapse_recursively = function(tree, node, current_root_node, keep_current_open, is_resolved)
|
|
if node == nil then
|
|
return
|
|
end
|
|
local root_node = M.get_root_node(tree, node)
|
|
if M.is_node_note(node) and root_node.resolved == is_resolved then
|
|
if keep_current_open and root_node == current_root_node then
|
|
return
|
|
end
|
|
node:collapse()
|
|
end
|
|
local children = node:get_child_ids()
|
|
for _, child in ipairs(children) do
|
|
M.collapse_recursively(tree, tree:get_node(child), current_root_node, keep_current_open, is_resolved)
|
|
end
|
|
end
|
|
|
|
---This function (settings.discussion_tree.expand_recursively) expands a node and its children.
|
|
---@param tree NuiTree
|
|
---@param node NuiTree.Node
|
|
---@param is_resolved boolean If true, expand resolved discussions. If false, expand unresolved discussions.
|
|
M.expand_recursively = function(tree, node, is_resolved)
|
|
if node == nil then
|
|
return
|
|
end
|
|
if M.is_node_note(node) and M.get_root_node(tree, node).resolved == is_resolved then
|
|
node:expand()
|
|
end
|
|
local children = node:get_child_ids()
|
|
for _, child in ipairs(children) do
|
|
M.expand_recursively(tree, tree:get_node(child), is_resolved)
|
|
end
|
|
end
|
|
|
|
--
|
|
-- 🌲 Helper Functions
|
|
--
|
|
---Inspired by default func https://github.com/MunifTanjim/nui.nvim/blob/main/lua/nui/tree/util.lua#L38
|
|
local function nui_tree_prepare_node(node)
|
|
if not node.text then
|
|
error("missing node.text")
|
|
end
|
|
|
|
local texts = node.text
|
|
if type(node.text) ~= "table" or node.text.content then
|
|
texts = { node.text }
|
|
end
|
|
|
|
local lines = {}
|
|
|
|
for i, text in ipairs(texts) do
|
|
local line = NuiLine()
|
|
|
|
line:append(string.rep(" ", node._depth - 1))
|
|
|
|
if i == 1 and node:has_children() then
|
|
line:append(node:is_expanded() and " " or " ")
|
|
if node.icon then
|
|
line:append(node.icon .. " ", node.icon_hl)
|
|
end
|
|
else
|
|
line:append(" ")
|
|
end
|
|
|
|
line:append(text, node.text_hl)
|
|
|
|
local note_id = tostring(node.is_root and node.root_note_id or node.id)
|
|
|
|
local e = require("gitlab.emoji")
|
|
|
|
---@type Emoji[]
|
|
local emojis = M.emojis[note_id]
|
|
local placed_emojis = {}
|
|
if emojis ~= nil then
|
|
for _, v in ipairs(emojis) do
|
|
local icon = e.emoji_map[v.name]
|
|
if icon ~= nil and not u.contains(placed_emojis, icon.moji) then
|
|
line:append(" ")
|
|
line:append(icon.moji)
|
|
table.insert(placed_emojis, icon.moji)
|
|
end
|
|
end
|
|
end
|
|
|
|
table.insert(lines, line)
|
|
end
|
|
|
|
return lines
|
|
end
|
|
|
|
M.rebuild_discussion_tree = function()
|
|
if M.linked_bufnr == nil then
|
|
return
|
|
end
|
|
M.switch_can_edit_bufs(true)
|
|
vim.api.nvim_buf_set_lines(M.linked_bufnr, 0, -1, false, {})
|
|
local discussion_tree_nodes = discussions_tree.add_discussions_to_table(M.discussions, false)
|
|
local discussion_tree =
|
|
NuiTree({ nodes = discussion_tree_nodes, bufnr = M.linked_bufnr, prepare_node = nui_tree_prepare_node })
|
|
discussion_tree:render()
|
|
M.set_tree_keymaps(discussion_tree, M.linked_bufnr, false)
|
|
M.discussion_tree = discussion_tree
|
|
M.switch_can_edit_bufs(false)
|
|
vim.api.nvim_set_option_value("filetype", "gitlab", { buf = M.linked_bufnr })
|
|
state.discussion_tree.resolved_expanded = false
|
|
state.discussion_tree.unresolved_expanded = false
|
|
end
|
|
|
|
M.rebuild_unlinked_discussion_tree = function()
|
|
if M.unlinked_bufnr == nil then
|
|
return
|
|
end
|
|
M.switch_can_edit_bufs(true)
|
|
vim.api.nvim_buf_set_lines(M.unlinked_bufnr, 0, -1, false, {})
|
|
local unlinked_discussion_tree_nodes = discussions_tree.add_discussions_to_table(M.unlinked_discussions, true)
|
|
local unlinked_discussion_tree = NuiTree({
|
|
nodes = unlinked_discussion_tree_nodes,
|
|
bufnr = M.unlinked_bufnr,
|
|
prepare_node = nui_tree_prepare_node,
|
|
})
|
|
unlinked_discussion_tree:render()
|
|
M.set_tree_keymaps(unlinked_discussion_tree, M.unlinked_bufnr, true)
|
|
M.unlinked_discussion_tree = unlinked_discussion_tree
|
|
M.switch_can_edit_bufs(false)
|
|
state.unlinked_discussion_tree.resolved_expanded = false
|
|
state.unlinked_discussion_tree.unresolved_expanded = false
|
|
end
|
|
|
|
M.switch_can_edit_bufs = function(bool)
|
|
u.switch_can_edit_buf(M.unlinked_bufnr, bool)
|
|
u.switch_can_edit_buf(M.linked_bufnr, bool)
|
|
vim.api.nvim_set_option_value("filetype", "gitlab", { buf = M.unlinked_bufnr })
|
|
vim.api.nvim_set_option_value("filetype", "gitlab", { buf = M.linked_bufnr })
|
|
end
|
|
|
|
M.add_discussion = function(arg)
|
|
local discussion = arg.data.discussion
|
|
if arg.unlinked then
|
|
if type(M.unlinked_discussions) ~= "table" then
|
|
M.unlinked_discussions = {}
|
|
end
|
|
table.insert(M.unlinked_discussions, 1, discussion)
|
|
M.rebuild_unlinked_discussion_tree()
|
|
return
|
|
end
|
|
if type(M.discussions) ~= "table" then
|
|
M.discussions = {}
|
|
end
|
|
table.insert(M.discussions, 1, discussion)
|
|
M.rebuild_discussion_tree()
|
|
end
|
|
|
|
M.create_split_and_bufs = function()
|
|
local position = state.settings.discussion_tree.position
|
|
local size = state.settings.discussion_tree.size
|
|
local relative = state.settings.discussion_tree.relative
|
|
|
|
local split = Split({
|
|
relative = relative,
|
|
position = position,
|
|
size = size,
|
|
})
|
|
|
|
local linked_bufnr = vim.api.nvim_create_buf(true, false)
|
|
local unlinked_bufnr = vim.api.nvim_create_buf(true, false)
|
|
|
|
return split, linked_bufnr, unlinked_bufnr
|
|
end
|
|
|
|
M.add_empty_titles = function(args)
|
|
M.switch_can_edit_bufs(true)
|
|
local ns_id = vim.api.nvim_create_namespace("GitlabNamespace")
|
|
vim.cmd("highlight default TitleHighlight guifg=#787878")
|
|
for _, section in ipairs(args) do
|
|
local bufnr, data, title = section[1], section[2], section[3]
|
|
if type(data) ~= "table" or #data == 0 then
|
|
vim.api.nvim_buf_set_lines(bufnr, 0, 1, false, { title })
|
|
local linnr = 1
|
|
vim.api.nvim_buf_set_extmark(
|
|
bufnr,
|
|
ns_id,
|
|
linnr - 1,
|
|
0,
|
|
{ end_row = linnr - 1, end_col = string.len(title), hl_group = "TitleHighlight" }
|
|
)
|
|
end
|
|
end
|
|
end
|
|
|
|
---Check if type of node is note or note body
|
|
---@param node NuiTree.Node?
|
|
---@return boolean
|
|
M.is_node_note = function(node)
|
|
if node and (node.type == "note_body" or node.type == "note") then
|
|
return true
|
|
else
|
|
return false
|
|
end
|
|
end
|
|
|
|
---Check if type of current node is note or note body
|
|
---@param tree NuiTree
|
|
---@return boolean
|
|
M.is_current_node_note = function(tree)
|
|
return M.is_node_note(tree:get_node())
|
|
end
|
|
|
|
M.set_tree_keymaps = function(tree, bufnr, unlinked)
|
|
vim.keymap.set("n", state.settings.discussion_tree.toggle_tree_type, function()
|
|
M.toggle_tree_type(unlinked)
|
|
end, { buffer = bufnr, desc = "Toggle tree type between `simple` and `by_file_name`" })
|
|
vim.keymap.set("n", state.settings.discussion_tree.edit_comment, function()
|
|
if M.is_current_node_note(tree) then
|
|
M.edit_comment(tree, unlinked)
|
|
end
|
|
end, { buffer = bufnr, desc = "Edit comment" })
|
|
vim.keymap.set("n", state.settings.discussion_tree.delete_comment, function()
|
|
if M.is_current_node_note(tree) then
|
|
M.delete_comment(tree, unlinked)
|
|
end
|
|
end, { buffer = bufnr, desc = "Delete comment" })
|
|
vim.keymap.set("n", state.settings.discussion_tree.toggle_resolved, function()
|
|
if M.is_current_node_note(tree) then
|
|
M.toggle_discussion_resolved(tree)
|
|
end
|
|
end, { buffer = bufnr, desc = "Toggle resolved" })
|
|
vim.keymap.set("n", state.settings.discussion_tree.toggle_node, function()
|
|
M.toggle_node(tree)
|
|
end, { buffer = bufnr, desc = "Toggle node" })
|
|
vim.keymap.set("n", state.settings.discussion_tree.toggle_all_discussions, function()
|
|
M.toggle_nodes(tree, unlinked, {
|
|
toggle_resolved = true,
|
|
toggle_unresolved = true,
|
|
keep_current_open = state.settings.discussion_tree.keep_current_open,
|
|
})
|
|
end, { buffer = bufnr, desc = "Toggle all nodes" })
|
|
vim.keymap.set("n", state.settings.discussion_tree.toggle_resolved_discussions, function()
|
|
M.toggle_nodes(tree, unlinked, {
|
|
toggle_resolved = true,
|
|
toggle_unresolved = false,
|
|
keep_current_open = state.settings.discussion_tree.keep_current_open,
|
|
})
|
|
end, { buffer = bufnr, desc = "Toggle resolved nodes" })
|
|
vim.keymap.set("n", state.settings.discussion_tree.toggle_unresolved_discussions, function()
|
|
M.toggle_nodes(tree, unlinked, {
|
|
toggle_resolved = false,
|
|
toggle_unresolved = true,
|
|
keep_current_open = state.settings.discussion_tree.keep_current_open,
|
|
})
|
|
end, { buffer = bufnr, desc = "Toggle unresolved nodes" })
|
|
vim.keymap.set("n", state.settings.discussion_tree.reply, function()
|
|
if M.is_current_node_note(tree) then
|
|
M.reply(tree)
|
|
end
|
|
end, { buffer = bufnr, desc = "Reply" })
|
|
vim.keymap.set("n", state.settings.discussion_tree.switch_view, function()
|
|
switch_view_type()
|
|
end, { buffer = bufnr, desc = "Switch view type" })
|
|
vim.keymap.set("n", state.settings.help, function()
|
|
help.open()
|
|
end, { buffer = bufnr, desc = "Open help popup" })
|
|
if not unlinked then
|
|
vim.keymap.set("n", state.settings.discussion_tree.jump_to_file, function()
|
|
if M.is_current_node_note(tree) then
|
|
M.jump_to_file(tree)
|
|
end
|
|
end, { buffer = bufnr, desc = "Jump to file" })
|
|
vim.keymap.set("n", state.settings.discussion_tree.jump_to_reviewer, function()
|
|
if M.is_current_node_note(tree) then
|
|
M.jump_to_reviewer(tree)
|
|
end
|
|
end, { buffer = bufnr, desc = "Jump to reviewer" })
|
|
end
|
|
vim.keymap.set("n", state.settings.discussion_tree.open_in_browser, function()
|
|
M.open_in_browser(tree)
|
|
end, { buffer = bufnr, desc = "Open the note in your browser" })
|
|
vim.keymap.set("n", "<leader>p", function()
|
|
M.print_node(tree)
|
|
end, { buffer = bufnr, desc = "Print current node (for debugging)" })
|
|
vim.keymap.set("n", state.settings.discussion_tree.add_emoji, function()
|
|
M.add_emoji_to_note(tree, unlinked)
|
|
end, { buffer = bufnr, desc = "Add an emoji reaction to the note/comment" })
|
|
vim.keymap.set("n", state.settings.discussion_tree.delete_emoji, function()
|
|
M.delete_emoji_from_note(tree, unlinked)
|
|
end, { buffer = bufnr, desc = "Remove an emoji reaction from the note/comment" })
|
|
|
|
emoji.init_popup(tree, bufnr)
|
|
end
|
|
|
|
M.redraw_resolved_status = function(tree, note, mark_resolved)
|
|
local current_text = tree.nodes.by_id["-" .. note.id].text
|
|
local target = mark_resolved and "resolved" or "unresolved"
|
|
local current = mark_resolved and "unresolved" or "resolved"
|
|
|
|
local function set_property(key, val)
|
|
tree.nodes.by_id["-" .. note.id][key] = val
|
|
end
|
|
|
|
local has_symbol = function(s)
|
|
return state.settings.discussion_tree[s] ~= nil and state.settings.discussion_tree[s] ~= ""
|
|
end
|
|
|
|
set_property("resolved", mark_resolved)
|
|
|
|
if not has_symbol(current) and not has_symbol(target) then
|
|
return
|
|
end
|
|
|
|
if not has_symbol(current) and has_symbol(target) then
|
|
set_property("text", (current_text .. " " .. state.settings.discussion_tree[target]))
|
|
elseif has_symbol(current) and not has_symbol(target) then
|
|
set_property("text", u.remove_last_chunk(current_text))
|
|
else
|
|
set_property("text", (u.remove_last_chunk(current_text) .. " " .. state.settings.discussion_tree[target]))
|
|
end
|
|
|
|
tree:render()
|
|
end
|
|
|
|
---Restore cursor position to the original node if possible
|
|
M.restore_cursor_position = function(tree, original_node, root_node)
|
|
local _, line_number = tree:get_node("-" .. tostring(original_node.id))
|
|
-- If current_node is has been collapsed, get line number of root node instead
|
|
if line_number == nil and root_node then
|
|
_, line_number = tree:get_node("-" .. tostring(root_node.id))
|
|
end
|
|
if line_number ~= nil then
|
|
vim.api.nvim_win_set_cursor(M.split.winid, { line_number, 0 })
|
|
end
|
|
end
|
|
|
|
---Replace text in discussion after note update.
|
|
---@param data Discussion[]|UnlinkedDiscussion[]
|
|
---@param discussion_id string
|
|
---@param note_id integer
|
|
---@param text string
|
|
M.replace_text = function(data, discussion_id, note_id, text)
|
|
for i, discussion in ipairs(data) do
|
|
if discussion.id == discussion_id then
|
|
for j, note in ipairs(discussion.notes) do
|
|
if note.id == note_id then
|
|
data[i].notes[j].body = text
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
---Get root node
|
|
---@param tree NuiTree
|
|
---@param node NuiTree.Node?
|
|
---@return NuiTree.Node?
|
|
M.get_root_node = function(tree, node)
|
|
if not node then
|
|
return nil
|
|
end
|
|
if node.type == "note_body" or node.type == "note" and not node.is_root then
|
|
local parent_id = node:get_parent_id()
|
|
return M.get_root_node(tree, tree:get_node(parent_id))
|
|
elseif node.is_root then
|
|
return node
|
|
end
|
|
end
|
|
|
|
---Get note node
|
|
---@param tree NuiTree
|
|
---@param node NuiTree.Node?
|
|
---@return NuiTree.Node?
|
|
M.get_note_node = function(tree, node)
|
|
if not node then
|
|
return nil
|
|
end
|
|
|
|
if node.type == "note_body" then
|
|
local parent_id = node:get_parent_id()
|
|
if parent_id == nil then
|
|
return node
|
|
end
|
|
return M.get_note_node(tree, tree:get_node(parent_id))
|
|
elseif node.type == "note" then
|
|
return node
|
|
end
|
|
end
|
|
|
|
M.add_reply_to_tree = function(tree, note, discussion_id)
|
|
local note_node = discussions_tree.build_note(note)
|
|
note_node:expand()
|
|
tree:add_node(note_node, discussion_id and ("-" .. discussion_id) or nil)
|
|
tree:render()
|
|
end
|
|
|
|
---@param tree NuiTree
|
|
M.open_in_browser = function(tree)
|
|
local current_node = tree:get_node()
|
|
local note_node = M.get_note_node(tree, current_node)
|
|
if note_node == nil then
|
|
return
|
|
end
|
|
local url = note_node.url
|
|
if url == nil then
|
|
u.notify("Could not get URL of note", vim.log.levels.ERROR)
|
|
return
|
|
end
|
|
|
|
u.open_in_browser(url)
|
|
end
|
|
|
|
M.add_emoji_to_note = function(tree, unlinked)
|
|
local node = tree:get_node()
|
|
local note_node = M.get_note_node(tree, node)
|
|
local root_node = M.get_root_node(tree, node)
|
|
local note_id = tonumber(note_node.is_root and root_node.root_note_id or note_node.id)
|
|
local note_id_str = tostring(note_id)
|
|
local emojis = require("gitlab.emoji").emoji_list
|
|
emoji.pick_emoji(emojis, function(name)
|
|
local body = { emoji = name, note_id = note_id }
|
|
job.run_job("/mr/awardable/note/", "POST", body, function(data)
|
|
if M.emojis[note_id_str] == nil then
|
|
M.emojis[note_id_str] = {}
|
|
table.insert(M.emojis[note_id_str], data.Emoji)
|
|
else
|
|
table.insert(M.emojis[note_id_str], data.Emoji)
|
|
end
|
|
if unlinked then
|
|
M.rebuild_unlinked_discussion_tree()
|
|
else
|
|
M.rebuild_discussion_tree()
|
|
end
|
|
u.notify("Emoji added", vim.log.levels.INFO)
|
|
end)
|
|
end)
|
|
end
|
|
|
|
M.delete_emoji_from_note = function(tree, unlinked)
|
|
local node = tree:get_node()
|
|
local note_node = M.get_note_node(tree, node)
|
|
local root_node = M.get_root_node(tree, node)
|
|
local note_id = tonumber(note_node.is_root and root_node.root_note_id or note_node.id)
|
|
local note_id_str = tostring(note_id)
|
|
|
|
local e = require("gitlab.emoji")
|
|
|
|
local emojis = {}
|
|
local current_emojis = M.emojis[note_id_str]
|
|
for _, current_emoji in ipairs(current_emojis) do
|
|
if state.USER.id == current_emoji.user.id then
|
|
table.insert(emojis, e.emoji_map[current_emoji.name])
|
|
end
|
|
end
|
|
|
|
emoji.pick_emoji(emojis, function(name)
|
|
local awardable_id
|
|
for _, current_emoji in ipairs(current_emojis) do
|
|
if current_emoji.name == name and current_emoji.user.id == state.USER.id then
|
|
awardable_id = current_emoji.id
|
|
break
|
|
end
|
|
end
|
|
job.run_job(string.format("/mr/awardable/note/%d/%d", note_id, awardable_id), "DELETE", nil, function(_)
|
|
local keep = {} -- Emojis to keep after deletion in the UI
|
|
for _, saved in ipairs(M.emojis[note_id_str]) do
|
|
if saved.name ~= name or saved.user.id ~= state.USER.id then
|
|
table.insert(keep, saved)
|
|
end
|
|
end
|
|
M.emojis[note_id_str] = keep
|
|
if unlinked then
|
|
M.rebuild_unlinked_discussion_tree()
|
|
else
|
|
M.rebuild_discussion_tree()
|
|
end
|
|
e.init_popup(tree, unlinked and M.unlinked_bufnr or M.linked_bufnr)
|
|
u.notify("Emoji removed", vim.log.levels.INFO)
|
|
end)
|
|
end)
|
|
end
|
|
|
|
-- For developers!
|
|
M.print_node = function(tree)
|
|
local current_node = tree:get_node()
|
|
vim.print(current_node)
|
|
end
|
|
|
|
return M
|