acoolname/gitlab.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Feat: save popup contents to register (#163)

Browse Source 
Users can now provide a backup register when creating comments, notes, and so forth which will automatically be populated with the contents of the buffer prior to submission to Gitlab. This ensures that even if the API call fails the contents of the buffer is saved, which prevents the user from losing their changes. This is a MINOR update.
This commit is contained in:
Jakub F. Bortlík
2024-01-22 14:14:40 +01:00
committed by GitHub
parent b6f023373a
commit 132dd60b95
3 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@@ -123,6 +123,7 @@ require("gitlab").setup({
pipeline = nil, pipeline = nil,
reply = nil, reply = nil,
squash_message = nil, squash_message = nil,
backup_register = nil,
}, },
discussion_tree = { -- The discussion tree that holds all comments discussion_tree = { -- The discussion tree that holds all comments
auto_open = true, -- Automatically open when the reviewer is opened auto_open = true, -- Automatically open when the reviewer is opened

18
doc/gitlab.nvim.txt
View File

@@ -156,6 +156,7 @@ you call this function with no values the defaults will be used:
pipeline = nil, pipeline = nil,
reply = nil, reply = nil,
squash_message = nil, squash_message = nil,
backup_register = nil,
}, },
discussion_tree = { -- The discussion tree that holds all comments discussion_tree = { -- The discussion tree that holds all comments
auto_open = true, -- Automatically open when the reviewer is opened auto_open = true, -- Automatically open when the reviewer is opened
@@ -308,7 +309,24 @@ which works similar to `create_multiline_comment` but prefills the comment
window with Gitlab’s suggest changes window with Gitlab’s suggest changes
<https://docs.gitlab.com/ee/user/project/merge_requests/reviews/suggestions.html> <https://docs.gitlab.com/ee/user/project/merge_requests/reviews/suggestions.html>
code block with prefilled code from the visual selection. code block with prefilled code from the visual selection.
Just like the summary, all the different kinds of comments are saved via the
`settings.popup.perform_action` keybinding.
BACKUP REGISTER *gitlab.nvim.backup-register*
Sometimes, the action triggered by `settings.popup.perform_action` can fail.
To prevent losing your carefully crafted note/comment/suggestion you can set
`settings.popup.backup_register` to a writable register (see |registers|) to
which the contents of the popup window will be saved just before the action is
performed. A practical setting is `settings.popup.backup_register = "+"` which
saves to the system clipboard (see |quoteplus|). This lets you easily apply
the action on Gitlab in a browser, if it keeps failing in `gitlab.nvim`.
If you experience such problems, please first read the
|gitlab.nvim.troubleshooting| section. If it does not help, see if there are
any relevant known <https://github.com/harrisoncramer/gitlab.nvim/issues>. If
there are none, please open one and provide any error messages that
`gitlab.nvim` may be showing.
DISCUSSIONS AND NOTES *gitlab.nvim.discussions-and-notes* DISCUSSIONS AND NOTES *gitlab.nvim.discussions-and-notes*

4
lua/gitlab/state.lua
View File

@@ -35,6 +35,7 @@ M.settings = {
help = nil, help = nil,
pipeline = nil, pipeline = nil,
squash_message = nil, squash_message = nil,
backup_register = nil,
}, },
discussion_tree = { discussion_tree = {
auto_open = true, auto_open = true,
@@ -273,6 +274,9 @@ M.set_popup_keymaps = function(popup, action, linewise_action, opts)
if action ~= nil then if action ~= nil then
vim.keymap.set("n", M.settings.popup.perform_action, function() vim.keymap.set("n", M.settings.popup.perform_action, function()
local text = u.get_buffer_text(popup.bufnr) local text = u.get_buffer_text(popup.bufnr)
if M.settings.popup.backup_register ~= nil then
vim.cmd("0,$yank " .. M.settings.popup.backup_register)
end
if opts.action_before_close then if opts.action_before_close then
action(text, popup.bufnr) action(text, popup.bufnr)
exit(popup, opts) exit(popup, opts)