Release 2.5.1 (#271)
* feat: Support for custom authentication provider functions (#270) * feat: Support for adding "draft" notes to the review, and publishing them, either individually or all at once. Addresses feature request #223. * feat: Lets users select + checkout a merge request directly within Neovim, without exiting to the terminal * fix: Checks that the remote feature branch exists and is up-to-date before creating a MR, starting a review, or opening the MR summary (#278) * docs: We require some state from Diffview, this shows how to load that state prior to installing w/ Packer. Fixes #94. This is a #MINOR release. --------- Co-authored-by: Jakub F. Bortlík <jakub.bortlik@proton.me> Co-authored-by: sunfuze <sunfuze.1989@gmail.com> Co-authored-by: Patrick Pichler <mail@patrickpichler.dev>
This commit is contained in:
Harrison (Harry) Cramer
committed by
GitHub
GitHub
parent
f10c4ebb8f
commit
cf6ccddce3
239
lua/gitlab/actions/draft_notes/init.lua
Executable file
239
lua/gitlab/actions/draft_notes/init.lua
Executable file
@@ -0,0 +1,239 @@
|
||||
-- This module is responsible for CRUD operations for the draft notes in the discussion tree.
|
||||
-- That includes things like editing existing draft notes in the tree, and
|
||||
-- and deleting them. Normal notes and comments are managed separately,
|
||||
-- under lua/gitlab/actions/discussions/init.lua
|
||||
local winbar = require("gitlab.actions.discussions.winbar")
|
||||
local diagnostics = require("gitlab.indicators.diagnostics")
|
||||
local common = require("gitlab.actions.common")
|
||||
local discussion_tree = require("gitlab.actions.discussions.tree")
|
||||
local job = require("gitlab.job")
|
||||
local NuiTree = require("nui.tree")
|
||||
local List = require("gitlab.utils.list")
|
||||
local u = require("gitlab.utils")
|
||||
local state = require("gitlab.state")
|
||||
|
||||
local M = {}
|
||||
|
||||
---@class AddDraftNoteOpts table
|
||||
---@field draft_note DraftNote
|
||||
---@field unlinked boolean
|
||||
|
||||
---Adds a draft note to the draft notes state, then rebuilds the view
|
||||
---@param opts AddDraftNoteOpts
|
||||
M.add_draft_note = function(opts)
|
||||
local new_draft_notes = u.ensure_table(state.DRAFT_NOTES)
|
||||
table.insert(new_draft_notes, opts.draft_note)
|
||||
state.DRAFT_NOTES = new_draft_notes
|
||||
local discussions = require("gitlab.actions.discussions")
|
||||
if opts.unlinked then
|
||||
discussions.rebuild_unlinked_discussion_tree()
|
||||
else
|
||||
discussions.rebuild_discussion_tree()
|
||||
end
|
||||
winbar.update_winbar()
|
||||
end
|
||||
|
||||
---Tells whether a draft note was left on a particular diff or is an unlinked note
|
||||
---@param note DraftNote
|
||||
M.has_position = function(note)
|
||||
return note.position.new_path ~= nil or note.position.old_path ~= nil
|
||||
end
|
||||
|
||||
---Returns a list of nodes to add to the discussion tree. Can filter and return only unlinked (note) nodes.
|
||||
---@param unlinked boolean
|
||||
---@return NuiTree.Node[]
|
||||
M.add_draft_notes_to_table = function(unlinked)
|
||||
local draft_notes = List.new(state.DRAFT_NOTES)
|
||||
|
||||
local draft_note_nodes = draft_notes
|
||||
---@param note DraftNote
|
||||
:filter(function(note)
|
||||
if unlinked then
|
||||
return not M.has_position(note)
|
||||
end
|
||||
return M.has_position(note)
|
||||
end)
|
||||
---@param note DraftNote
|
||||
:map(function(note)
|
||||
local _, root_text, root_text_nodes = discussion_tree.build_note(note)
|
||||
return NuiTree.Node({
|
||||
range = (type(note.position) == "table" and note.position.line_range or nil),
|
||||
text = root_text,
|
||||
type = "note",
|
||||
is_root = true,
|
||||
is_draft = true,
|
||||
id = note.id,
|
||||
root_note_id = note.id,
|
||||
file_name = (type(note.position) == "table" and note.position.new_path or nil),
|
||||
new_line = (type(note.position) == "table" and note.position.new_line or nil),
|
||||
old_line = (type(note.position) == "table" and note.position.old_line or nil),
|
||||
resolvable = false,
|
||||
resolved = false,
|
||||
url = state.INFO.web_url .. "#note_" .. note.id,
|
||||
}, root_text_nodes)
|
||||
end)
|
||||
|
||||
return draft_note_nodes
|
||||
|
||||
-- TODO: Combine draft_notes and normal discussion nodes in the complex discussion
|
||||
-- tree. The code for that feature is a clusterfuck so this is difficult
|
||||
-- if state.settings.discussion_tree.tree_type == "simple" then
|
||||
-- return draft_note_nodes
|
||||
-- end
|
||||
end
|
||||
|
||||
---Send edits will actually send the edits to Gitlab and refresh the draft_notes tree
|
||||
M.send_edits = function(note_id)
|
||||
return function(text)
|
||||
local all_notes = List.new(state.DRAFT_NOTES)
|
||||
local the_note = all_notes:find(function(note)
|
||||
return note.id == note_id
|
||||
end)
|
||||
local body = { note = text, position = the_note.position }
|
||||
job.run_job(string.format("/mr/draft_notes/%d", note_id), "PATCH", body, function(data)
|
||||
u.notify(data.message, vim.log.levels.INFO)
|
||||
local has_position = false
|
||||
local new_draft_notes = all_notes:map(function(note)
|
||||
if note.id == note_id then
|
||||
has_position = M.has_position(note)
|
||||
note.note = text
|
||||
end
|
||||
return note
|
||||
end)
|
||||
state.DRAFT_NOTES = new_draft_notes
|
||||
local discussions = require("gitlab.actions.discussions")
|
||||
if has_position then
|
||||
discussions.rebuild_discussion_tree()
|
||||
else
|
||||
discussions.rebuild_unlinked_discussion_tree()
|
||||
end
|
||||
winbar.update_winbar()
|
||||
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 = common.get_note_node(tree, current_node)
|
||||
local root_node = common.get_root_node(tree, current_node)
|
||||
|
||||
if note_node == nil or root_node == nil then
|
||||
u.notify("Could not get note or root node", vim.log.levels.ERROR)
|
||||
return
|
||||
end
|
||||
|
||||
---@type integer
|
||||
local note_id = note_node.is_root and root_node.id or note_node.id
|
||||
|
||||
job.run_job(string.format("/mr/draft_notes/%d", note_id), "DELETE", nil, function(data)
|
||||
u.notify(data.message, vim.log.levels.INFO)
|
||||
|
||||
local has_position = false
|
||||
local new_draft_notes = List.new(state.DRAFT_NOTES):filter(function(note)
|
||||
if note.id ~= note_id then
|
||||
return true
|
||||
else
|
||||
has_position = M.has_position(note)
|
||||
return false
|
||||
end
|
||||
end)
|
||||
|
||||
state.DRAFT_NOTES = new_draft_notes
|
||||
local discussions = require("gitlab.actions.discussions")
|
||||
if has_position then
|
||||
discussions.rebuild_discussion_tree()
|
||||
else
|
||||
discussions.rebuild_unlinked_discussion_tree()
|
||||
end
|
||||
|
||||
if state.settings.discussion_signs.enabled and state.DISCUSSION_DATA then
|
||||
diagnostics.refresh_diagnostics()
|
||||
end
|
||||
|
||||
winbar.update_winbar()
|
||||
common.add_empty_titles()
|
||||
end)
|
||||
end
|
||||
|
||||
-- This function will trigger a popup prompting you to publish the current draft comment
|
||||
M.publish_draft = function(tree)
|
||||
vim.ui.select({ "Confirm", "Cancel" }, {
|
||||
prompt = "Publish current draft comment?",
|
||||
}, function(choice)
|
||||
if choice == "Confirm" then
|
||||
M.confirm_publish_draft(tree)
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
-- This function will trigger a popup prompting you to publish all draft notes
|
||||
M.publish_all_drafts = function()
|
||||
vim.ui.select({ "Confirm", "Cancel" }, {
|
||||
prompt = "Publish all drafts?",
|
||||
}, function(choice)
|
||||
if choice == "Confirm" then
|
||||
M.confirm_publish_all_drafts()
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
---Publishes all draft notes and comments. Re-renders all discussion views.
|
||||
M.confirm_publish_all_drafts = function()
|
||||
local body = { publish_all = true }
|
||||
job.run_job("/mr/draft_notes/publish", "POST", body, function(data)
|
||||
u.notify(data.message, vim.log.levels.INFO)
|
||||
state.DRAFT_NOTES = {}
|
||||
local discussions = require("gitlab.actions.discussions")
|
||||
discussions.refresh(function()
|
||||
discussions.rebuild_discussion_tree()
|
||||
discussions.rebuild_unlinked_discussion_tree()
|
||||
winbar.update_winbar()
|
||||
end)
|
||||
end)
|
||||
end
|
||||
|
||||
---Publishes the current draft note that is being hovered over in the tree,
|
||||
---and then makes an API call to refresh the relevant data for that tree
|
||||
---and re-render it.
|
||||
---@param tree NuiTree
|
||||
M.confirm_publish_draft = function(tree)
|
||||
local current_node = tree:get_node()
|
||||
local note_node = common.get_note_node(tree, current_node)
|
||||
local root_node = common.get_root_node(tree, current_node)
|
||||
|
||||
if note_node == nil or root_node == nil then
|
||||
u.notify("Could not get note or root node", vim.log.levels.ERROR)
|
||||
return
|
||||
end
|
||||
|
||||
---@type integer
|
||||
local note_id = note_node.is_root and root_node.id or note_node.id
|
||||
local body = { note = note_id, publish_all = false }
|
||||
job.run_job("/mr/draft_notes/publish", "POST", body, function(data)
|
||||
u.notify(data.message, vim.log.levels.INFO)
|
||||
|
||||
local has_position = false
|
||||
local new_draft_notes = List.new(state.DRAFT_NOTES):filter(function(note)
|
||||
if note.id ~= note_id then
|
||||
return true
|
||||
else
|
||||
has_position = M.has_position(note)
|
||||
return false
|
||||
end
|
||||
end)
|
||||
|
||||
state.DRAFT_NOTES = new_draft_notes
|
||||
local discussions = require("gitlab.actions.discussions")
|
||||
discussions.refresh(function()
|
||||
if has_position then
|
||||
discussions.rebuild_discussion_tree()
|
||||
else
|
||||
discussions.rebuild_unlinked_discussion_tree()
|
||||
end
|
||||
winbar.update_winbar()
|
||||
end)
|
||||
end)
|
||||
end
|
||||
|
||||
return M
|
||||
Reference in New Issue
Block a user