refactor: deprecate create_multiline_comment

Author: jakubbortlik

cmd/app/comment.go

@@ -42,7 +42,7 @@ type DeleteCommentRequest struct {
 	DiscussionId string `json:"discussion_id" validate:"required"`
 }
 
-/* deleteComment deletes a note, multiline comment, or comment, which are all considered discussion notes. */
+/* deleteComment deletes a note or comment, which are all considered discussion notes. */
 func (a commentService) deleteComment(w http.ResponseWriter, r *http.Request) {
 	payload := r.Context().Value(payload("payload")).(*DeleteCommentRequest)
 
@@ -81,7 +81,7 @@ func (comment CommentWithPosition) GetPositionData() PositionData {
 	return comment.PositionData
 }
 
-/* postComment creates a note, multiline comment, or comment. */
+/* postComment creates a note or comment. */
 func (a commentService) postComment(w http.ResponseWriter, r *http.Request) {
 	payload := r.Context().Value(payload("payload")).(*PostCommentRequest)
 

doc/gitlab.nvim.txt

@@ -450,18 +450,15 @@ the configuration.
 REVIEWING AN MR                                  *gitlab.nvim.reviewing-an-mr*
 
 The `review` action will open a diff of the changes. You can leave comments
-using the `create_comment` action. In visual mode, add multiline comments with
-the `create_multiline_comment` command, and add suggested changes with the
+using the `create_comment` action, and add suggestions for changes with the
 `create_comment_suggestion` command:
 >lua
     require("gitlab").review()
     require("gitlab").create_comment()
-    require("gitlab").create_multiline_comment()
     require("gitlab").create_comment_suggestion()
 <
 For suggesting changes you can use `create_comment_suggestion` in visual mode
-which works similar to `create_multiline_comment` but prefills the comment
-window with Gitlab’s suggest changes
+which prefills the comment window with Gitlab’s suggest changes
 <https://docs.gitlab.com/ee/user/project/merge_requests/reviews/suggestions.html>
 code block with prefilled code from the visual selection. Just like the
 summary, all the different kinds of comments are saved via the
@@ -883,33 +880,28 @@ have permission or has not previously approved the MR.
                                                                 *gitlab.nvim.create_comment*
 gitlab.create_comment() ~
 
-Opens a popup to create a comment on the current line. Must be called when focused on the
-reviewer pane (see the gitlab.nvim.review command), otherwise it will error.
+Opens a popup to create a comment on the selected line(s) in the current
+buffer. Must be called when focused on the reviewer pane (see the
+|gitlab.nvim.review| command). In normal mode comments on the current line. In
+visual mode comments on the selected lines
 >lua
   require("gitlab").create_comment()
-
-After the comment is typed, submit it to Gitlab via the
-`keymaps.popup.perform_action` keybinding, by default `ZZ`.
-
-                                                                *gitlab.nvim.create_multiline_comment*
-gitlab.create_multiline_comment() ~
-
-Opens a popup to create a multi-line comment. May only be called in visual
-mode, and will use the currently selected lines.
->lua
-  require("gitlab").create_multiline_comment()
-
-After the comment is typed, submit it to Gitlab via the
-`keymaps.popup.perform_linewise_action` keybinding, by default `ZA`.
+<
+You can use the `keymaps.popup.perform_linewise_action` keybinding (by default
+`ZA`) to attach a file to the comment. After the comment is typed, submit it
+to Gitlab via the `keymaps.popup.perform_action` keybinding, by default `ZZ`.
+Discard the comment with `keymaps.popup.discard_changes` (`ZQ`), otherwise if
+you close the popup with something like `<c-w>q`, the comment contents are
+saved to the temporary register(s) (|gitlab.nvim.temp-registers|).
 
                                                                 *gitlab.nvim.create_comment_suggestion*
 gitlab.create_comment_suggestion() ~
 
 Opens a popup to create a comment suggestion (aka a comment that makes a committable
 change suggestion to the currently selected lines).
 >lua
-  require("gitlab").create_multiline_comment()
-
+  require("gitlab").create_comment_suggestion()
+<
 After the comment is typed, submit it to Gitlab via the
 `keymaps.popup.perform_linewise_action` keybinding, by default `ZA`.
 

lua/gitlab/actions/comment.lua

@@ -220,8 +220,9 @@ M.create_comment_layout = function(opts)
   return layout
 end
 
---- This function will open a comment popup in order to create a comment on the changed/updated
---- line in the current MR
+--- Creates a comment on the selected line(s) in the current buffer.
+--- In normal mode comments on the current line.
+--- In visual mode comments on the whole selection.
 M.create_comment = function()
   M.location = Location.new()
   if not M.can_create_comment(false) then
@@ -232,19 +233,6 @@ M.create_comment = function()
   layout:mount()
 end
 
---- This function will open a multi-line comment popup in order to create a multi-line comment
---- on the changed/updated line in the current MR
-M.create_multiline_comment = function()
-  M.location = Location.new()
-  if not M.can_create_comment(true) then
-    u.press_escape()
-    return
-  end
-
-  local layout = M.create_comment_layout({ unlinked = false })
-  layout:mount()
-end
-
 --- This function will open a a popup to create a "note" (e.g. unlinked comment)
 --- on the changed/updated line in the current MR
 M.create_note = function()
@@ -394,7 +382,7 @@ M.can_create_comment = function(must_be_visual)
     return false
   end
 
-  -- Check we're in visual mode for code suggestions and multiline comments
+  -- Check we're in visual mode for code suggestions
   if must_be_visual and not u.check_visual_mode() then
     return false
   end

lua/gitlab/init.lua

@@ -75,7 +75,10 @@ return {
   add_assignee = async.sequence({ info, project_members }, assignees_and_reviewers.add_assignee),
   delete_assignee = async.sequence({ info, project_members }, assignees_and_reviewers.delete_assignee),
   create_comment = async.sequence({ info, revisions }, comment.create_comment),
-  create_multiline_comment = async.sequence({ info, revisions }, comment.create_multiline_comment),
+  create_multiline_comment = async.sequence({ info, revisions }, function()
+    u.notify("create_multiline_comment() is deprecated, use create_comment()", vim.log.levels.WARN)
+    comment.create_comment()
+  end),
   create_comment_suggestion = async.sequence({ info, revisions }, comment.create_comment_suggestion),
   create_comment_with_suggestion = async.sequence({ info, revisions }, comment.create_comment_with_suggestion),
   move_to_discussion_tree_from_diagnostic = async.sequence({}, discussions.move_to_discussion_tree),

lua/gitlab/reviewer/init.lua

@@ -344,7 +344,7 @@ end
 
 ---Set the operatorfunc that will work on the lines defined by the motion that follows after the
 ---operator mapping, and enter the operator-pending mode.
----@param cb string Name of the gitlab.nvim API function to call, e.g., "create_multiline_comment".
+---@param cb string Name of the gitlab.nvim API function to call, e.g., "create_comment".
 local function execute_operatorfunc(cb)
   M.old_opfunc = vim.opt.operatorfunc
   M.old_winnr = vim.api.nvim_get_current_win()
@@ -385,12 +385,12 @@ M.set_keymaps = function(bufnr)
       keymaps.reviewer.create_comment,
       function()
         M.operator_count = vim.v.count
-        execute_operatorfunc("create_multiline_comment")
+        execute_operatorfunc("create_comment")
       end,
       { buffer = bufnr, desc = "Create comment for range of motion", nowait = keymaps.reviewer.create_comment_nowait }
     )
     vim.keymap.set("v", keymaps.reviewer.create_comment, function()
-      require("gitlab").create_multiline_comment()
+      require("gitlab").create_comment()
     end, {
       buffer = bufnr,
       desc = "Create comment for selected text",

lua/gitlab/utils/init.lua

@@ -588,7 +588,7 @@ end
 M.check_visual_mode = function()
   local mode = vim.api.nvim_get_mode().mode
   if mode ~= "v" and mode ~= "V" then
-    M.notify("Code suggestions and multiline comments are only available in visual mode", vim.log.levels.ERROR)
+    M.notify("Code suggestions are only available in visual mode", vim.log.levels.ERROR)
     return false
   end
   return true