2.0.0 (#196)

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.

Author: harrisoncramer

.github/CONTRIBUTING.md

@@ -45,8 +45,10 @@ $ stylua .
 $ luacheck --globals vim busted --no-max-line-length -- .
 ```
 
-4. Make the merge request to the `main` branch of `.gitlab.nvim`
+4. Make the merge request to the `develop` branch of `.gitlab.nvim`
 
 Please provide a description of the feature, and links to any relevant issues. 
 
-That's it! I'll try to respond to any incoming merge request in a few days. Once we've reviewed it and it's been merged into main, the pipeline will detect whether we're merging in a patch, minor, or major change, and create a new tag (e.g. 1.0.12) and release.
+That's it! I'll try to respond to any incoming merge request in a few days. Once we've reviewed it, it will be merged into the develop branch. 
+
+After some time, if the develop branch is found to be stable, that branch will be merged into `main` and released. When merged into `main` the pipeline will detect whether we're merging in a patch, minor, or major change, and create a new tag (e.g. 1.0.12) and release.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -3,15 +3,17 @@ name: Bug report
 about: Create a report to help improve gitlab.nvim!
 title: ''
 labels: ''
-assignees: ''
-
 ---
 
 ## Prerequsities
 
-- [ ] The "Troubleshooting" section of the README did not help
-- [ ] I've installed the required dependencies
 - [ ] I'm on the latest version of the plugin
+- [ ] I've installed the required dependencies
+- [ ] I've run `:h gitlab.nvim.troubleshooting` and followed the steps there
+
+## Setup Configuration and Environment
+
+Please post here the options you're passing to configure `gitlab.nvim` and specify any environment variables you're relying on.
 
 ## Bug Description
 
@@ -26,5 +28,3 @@ A clear and concise description of what the bug is.
 ## Screenshots
 
 If applicable, add screenshots to help explain your problem.
-
-## Other Details

.github/workflows/go.yaml

@@ -3,6 +3,7 @@ on:
   pull_request:
     branches:
       - main
+      - develop
 jobs:
   go_lint:
     name: Lint Go 💅 

.github/workflows/lua.yaml

@@ -3,6 +3,7 @@ on:
   pull_request:
     branches:
       - main
+      - develop
 jobs:
   lua_lint:
     name: Lint Lua 💅

README.md

@@ -150,6 +150,7 @@ require("gitlab").setup({
     resolved = '✓', -- Symbol to show next to resolved discussions
     unresolved = '-', -- Symbol to show next to unresolved discussions
     tree_type = "simple", -- Type of discussion tree - "simple" means just list of discussions, "by_file_name" means file tree with discussions under file
+    toggle_tree_type = "i", -- Toggle type of discussion tree - "simple", or "by_file_name"
     winbar = nil -- Custom function to return winbar title, should return a string. Provided with WinbarTable (defined in annotations.lua)
                  -- If using lualine, please add "gitlab" to disabled file types, otherwise you will not see the winbar.
   },
@@ -169,36 +170,17 @@ require("gitlab").setup({
       "pipeline",
     },
   },
-  discussion_sign_and_diagnostic = {
-    skip_resolved_discussion = false,
-    skip_old_revision_discussion = true,
-  },
-  discussion_sign = {
-    -- See :h sign_define for details about sign configuration.
-    enabled = true,
-    text = "💬",
-    linehl = nil,
-    texthl = nil,
-    culhl = nil,
-    numhl = nil,
-    priority = 20, -- Priority of sign, the lower the number the higher the priority
-    helper_signs = {
-      -- For multiline comments the helper signs are used to indicate the whole context
-      -- Priority of helper signs is lower than the main sign (-1).
-      enabled = true,
-      start = "↑",
-      mid = "|",
-      ["end"] = "↓",
+  discussion_signs = {
+    enabled = true, -- Show diagnostics for gitlab comments in the reviewer
+    skip_resolved_discussion = false, -- Show diagnostics for resolved discussions
+    severity = vim.diagnostic.severity.INFO, -- ERROR, WARN, INFO, or HINT
+    virtual_text = false, -- Whether to show the comment text inline as floating virtual text
+    priority = 100, -- Higher will override LSP warnings, etc
+    icons = {
+      comment = "→|",
+      range = " |",
     },
   },
-  discussion_diagnostic = {
-    -- If you want to customize diagnostics for discussions you can make special config
-    -- for namespace `gitlab_discussion`. See :h vim.diagnostic.config
-    enabled = true,
-    severity = vim.diagnostic.severity.INFO,
-    code = nil, -- see :h diagnostic-structure
-    display_opts = {}, -- see opts in vim.diagnostic.set
-  },
   pipeline = {
     created = "",
     pending = "",
@@ -230,7 +212,7 @@ require("gitlab").setup({
       directory = "Directory",
       directory_icon = "DiffviewFolderSign",
       file_name = "Normal",
-      }
+    }
   }
 })
 ```

doc/gitlab.nvim.txt

@@ -182,6 +182,7 @@ you call this function with no values the defaults will be used:
         resolved = '✓', -- Symbol to show next to resolved discussions
         unresolved = '-', -- Symbol to show next to unresolved discussions
         tree_type = "simple", -- Type of discussion tree - "simple" means just list of discussions, "by_file_name" means file tree with discussions under file
+        toggle_tree_type = "i", -- Toggle type of discussion tree - "simple", or "by_file_name"
         winbar = nil -- Custom function to return winbar title, should return a string. Provided with WinbarTable (defined in annotations.lua)
                      -- If using lualine, please add "gitlab" to disabled file types, otherwise you will not see the winbar.
       },
@@ -203,35 +204,16 @@ you call this function with no values the defaults will be used:
           "labels",
         },
       },
-      discussion_sign_and_diagnostic = {
-        skip_resolved_discussion = false,
-        skip_old_revision_discussion = true,
-      },
-      discussion_sign = {
-        -- See :h sign_define for details about sign configuration.
-        enabled = true,
-        text = "💬",
-        linehl = nil,
-        texthl = nil,
-        culhl = nil,
-        numhl = nil,
-        priority = 20, -- Priority of sign, the lower the number the higher the priority
-        helper_signs = {
-          -- For multiline comments the helper signs are used to indicate the whole context
-          -- Priority of helper signs is lower than the main sign (-1).
-          enabled = true,
-          start = "↑",
-          mid = "|",
-          ["end"] = "↓",
-        },
-      },
-      discussion_diagnostic = {
-        -- If you want to customize diagnostics for discussions you can make special config
-        -- for namespace `gitlab_discussion`. See :h vim.diagnostic.config
-        enabled = true,
-        severity = vim.diagnostic.severity.INFO,
-        code = nil, -- see :h diagnostic-structure
-        display_opts = {}, -- see opts in vim.diagnostic.set
+      discussion_signs = {
+	enabled = true,
+	skip_resolved_discussion = false,
+	skip_old_revision_discussion = false,
+	severity = vim.diagnostic.severity.INFO,
+	virtual_text = false,
+	icons = {
+	  comment = "→|",
+	  range = " |",
+	},
       },
       pipeline = {
         created = "",
@@ -385,46 +367,17 @@ These labels will be visible in the summary panel, as long as you provide the
 
 SIGNS AND DIAGNOSTICS                      *gitlab.nvim.signs-and-diagnostics*
 
-By default when reviewing files you will see signs and diagnostics (if enabled
-in configuration). When cursor is on diagnostic line you can view discussion
-thread by using `vim.diagnostic.show`. You can also jump to discussion tree
-where you can reply, edit or delete discussion.
+By default when reviewing files you will see diagnostics in the reviewer 
+for comments that have been added to a review. When the cursor is on 
+diagnostic line you can view discussion thread by using `vim.diagnostic.show`. 
 
+You can also jump to discussion tree for the given comment:
 >lua
     require("gitlab").move_to_discussion_tree_from_diagnostic()
-<
 
-The `discussion_sign` configuration controls the display of signs for
-discussions in the reviewer pane. This allows users to jump to comments in the
-current buffer in the reviewer pane directly. Keep in mind that the highlights
-provided here can be overridden by other highlights (for example from
-`diffview.nvim`).
-
-These diagnostics are configurable in the same way that diagnostics are
-typically configurable in Neovim. For instance, the `severity` key sets the
-diagnostic severity level and should be set to one of
-`vim.diagnostic.severity.ERROR`, `vim.diagnostic.severity.WARN`,
-`vim.diagnostic.severity.INFO`, or `vim.diagnostic.severity.HINT`. The
-`display_opts` option configures the diagnostic display options (this is
-directly used as opts in vim.diagnostic.set). Here you can configure values
-like:
-
-- `virtual_text` - Show virtual text for diagnostics.
-- `underline` - Underline text for diagnostics.
-
-Diagnostics for discussions use the `gitlab_discussion` namespace. See
-|vim.diagnostic.config| and |diagnostic-structure| for more details. Signs and
-diagnostics have common settings in `discussion_sign_and_diagnostic`. This
-allows customizing if discussions that are resolved or no longer relevant
-should still display visual indicators in the editor. The
-`skip_resolved_discussion` Boolean will control visibility of resolved
-discussions, and `skip_old_revision_discussion` whether to show signs and
-diagnostics for discussions on outdated diff revisions.
-
-When interacting with multiline comments, the cursor must be on the "main" line
-of diagnostic, where the `discussion_sign.text` is shown, otherwise
-`vim.diagnostic.show` and `move_to_discussion_tree_from_diagnostic` will not
-work.
+You may skip resolved discussions by toggling `discussion_signs.skip_resolved_discussion`
+in your setup function to true. By default, discussions from this plugin
+are shown at the INFO severity level (see :h vim.diagnostic.severity).
 
 EMOJIS                                       *gitlab.nvim.emojis*
 

lua/gitlab/actions/assignees_and_reviewers.lua

@@ -2,6 +2,7 @@
 -- and assignees in Gitlab, those who must review an MR.
 local u = require("gitlab.utils")
 local job = require("gitlab.job")
+local List = require("gitlab.utils.list")
 local state = require("gitlab.state")
 local M = {}
 
@@ -67,13 +68,11 @@ end
 
 M.filter_eligible = function(current, to_remove)
   local ids = u.extract(to_remove, "id")
-  local res = {}
-  for _, member in ipairs(current) do
+  return List.new(current):filter(function(member)
     if not u.contains(ids, member.id) then
-      table.insert(res, member)
+      return true
     end
-  end
-  return res
+  end)
 end
 
 return M

lua/gitlab/actions/comment.lua

@@ -5,9 +5,11 @@ local Popup = require("nui.popup")
 local state = require("gitlab.state")
 local job = require("gitlab.job")
 local u = require("gitlab.utils")
+local git = require("gitlab.git")
 local discussions = require("gitlab.actions.discussions")
 local miscellaneous = require("gitlab.actions.miscellaneous")
 local reviewer = require("gitlab.reviewer")
+local Location = require("gitlab.reviewer.location")
 local M = {}
 
 -- Popup creation is wrapped in a function so that it is performed *after* user
@@ -20,6 +22,15 @@ end
 -- This function will open a comment popup in order to create a comment on the changed/updated
 -- line in the current MR
 M.create_comment = function()
+  local has_clean_tree = git.has_clean_tree()
+  local is_modified = vim.api.nvim_buf_get_option(0, "modified")
+  if state.settings.reviewer_settings.diffview.imply_local and (is_modified or not has_clean_tree) then
+    u.notify(
+      "Cannot leave comments on changed files. \n Please stash all local changes or push them to the feature branch.",
+      vim.log.levels.WARN
+    )
+    return
+  end
   local comment_popup = create_comment_popup()
   comment_popup:mount()
   state.set_popup_keymaps(comment_popup, function(text)
@@ -95,30 +106,11 @@ M.create_note = function()
   end, miscellaneous.attach_file)
 end
 
----@class LineRange
----@field start_line integer
----@field end_line integer
-
----@class ReviewerLineInfo
----@field old_line integer
----@field new_line integer
----@field type string either "new" or "old"
-
----@class ReviewerRangeInfo
----@field start ReviewerLineInfo
----@field end ReviewerLineInfo
-
----@class ReviewerInfo
----@field file_name string
----@field old_line integer | nil
----@field new_line integer | nil
----@field range_info ReviewerRangeInfo|nil
-
 ---This function (settings.popup.perform_action) will send the comment to the Go server
 ---@param text string comment text
----@param range LineRange | nil range of visuel selection or nil
+---@param visual_range LineRange | nil range of visual selection or nil
 ---@param unlinked boolean | nil if true, the comment is not linked to a line
-M.confirm_create_comment = function(text, range, unlinked)
+M.confirm_create_comment = function(text, visual_range, unlinked)
   if text == nil then
     u.notify("Reviewer did not provide text of change", vim.log.levels.ERROR)
     return
@@ -129,33 +121,42 @@ M.confirm_create_comment = function(text, range, unlinked)
     job.run_job("/mr/comment", "POST", body, function(data)
       u.notify("Note created!", vim.log.levels.INFO)
       discussions.add_discussion({ data = data, unlinked = true })
-      discussions.refresh_discussion_data()
+      discussions.refresh()
     end)
     return
   end
 
-  local reviewer_info = reviewer.get_location(range)
-  if not reviewer_info then
+  local reviewer_data = reviewer.get_reviewer_data()
+  if reviewer_data == nil then
+    u.notify("Error getting reviewer data", vim.log.levels.ERROR)
+    return
+  end
+
+  local location = Location.new(reviewer_data, visual_range)
+  location:build_location_data()
+  local location_data = location.location_data
+  if location_data == nil then
+    u.notify("Error getting location information", vim.log.levels.ERROR)
     return
   end
 
   local revision = state.MR_REVISIONS[1]
   local body = {
+    type = "text",
     comment = text,
-    file_name = reviewer_info.file_name,
-    old_line = reviewer_info.old_line,
-    new_line = reviewer_info.new_line,
+    file_name = reviewer_data.file_name,
     base_commit_sha = revision.base_commit_sha,
     start_commit_sha = revision.start_commit_sha,
     head_commit_sha = revision.head_commit_sha,
-    type = "text",
-    line_range = reviewer_info.range_info,
+    old_line = location_data.old_line,
+    new_line = location_data.new_line,
+    line_range = location_data.line_range,
   }
 
   job.run_job("/mr/comment", "POST", body, function(data)
     u.notify("Comment created!", vim.log.levels.INFO)
     discussions.add_discussion({ data = data, unlinked = false })
-    discussions.refresh_discussion_data()
+    discussions.refresh()
   end)
 end
 

lua/gitlab/actions/create_mr.lua

@@ -5,6 +5,7 @@ local Input = require("nui.input")
 local Popup = require("nui.popup")
 local job = require("gitlab.job")
 local u = require("gitlab.utils")
+local git = require("gitlab.git")
 local state = require("gitlab.state")
 local miscellaneous = require("gitlab.actions.miscellaneous")
 
@@ -124,7 +125,7 @@ M.pick_target = function(args)
 end
 
 local function make_template_path(t)
-  local base_dir = vim.fn.trim(vim.fn.system({ "git", "rev-parse", "--show-toplevel" }))
+  local base_dir = git.base_dir()
   return base_dir
     .. state.settings.file_separator
     .. ".gitlab"