Fix: Rebuild Diagnostics + Signs (#203)

* Updated lua/gitlab/actions/discussions/signs.lua

* Initial commit of changes

* Updated lua/gitlab/actions/discussions/signs.lua

* Updated lua/gitlab/actions/discussions/signs.lua

* Updated lua/gitlab/actions/discussions/init.lua

* Updated lua/gitlab/actions/discussions/signs.lua

* Split up signs and diagnostics

* Moved common to common file

* Continued modularization

* added formatting

* Moved signs/diagnostic lines into appropriate files

* Updated lua/gitlab/reviewer/init.lua

* Renamed is_current_sha => is_current_sha_focused

* Updated lua/gitlab/reviewer/init.lua

* Moved actions.indicators => indicators

* Split discussions/signs apart into separate modules

* Fixed filter function, fixed discussions

* Updated lua/gitlab/indicators/diagnostics.lua

* Setting diagnostics, handling and catching errors

* Greatly simplified diagnostics setup

* Re-split multi-line

* Updated lua/gitlab/indicators/diagnostics.lua

* Setting up signs

* Updated lua/gitlab/indicators/signs.lua

* Updated signs + display options

* Updated lua/gitlab/state.lua

* Updated doc/gitlab.nvim.txt

* Updated readme

* Added deprecation warning

* formatting

Author: harrisoncramer

README.md

@@ -170,35 +170,16 @@ require("gitlab").setup({
       "pipeline",
     },
   },
-  discussion_sign_and_diagnostic = {
+  discussion_signs = {
+    enabled = true, -- Show diagnostics for gitlab comments in the reviewer
     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
+    virtual_text = false,
+    icons = {
+      comment = "→|",
+      range = " |",
+    },
+    skip_old_revision_discussion = false, 
   },
   pipeline = {
     created = "",
@@ -231,7 +212,7 @@ require("gitlab").setup({
       directory = "Directory",
       directory_icon = "DiffviewFolderSign",
       file_name = "Normal",
-      }
+    }
   }
 })
 ```

doc/gitlab.nvim.txt

@@ -204,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 = "",
@@ -386,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/discussions/init.lua

@@ -13,7 +13,8 @@ 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 signs = require("gitlab.actions.discussions.signs")
+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")
@@ -63,7 +64,8 @@ M.initialize_discussions = function()
     M.modifiable(false)
   end)
   reviewer.set_callback_for_reviewer_leave(function()
-    signs.clear_signs_and_diagnostics()
+    signs.clear_signs()
+    diagnostics.clear_diagnostics()
     M.modifiable(true)
   end)
 end
@@ -92,11 +94,8 @@ end
 
 --- Take existing data and refresh the diagnostics, the winbar, and the signs
 M.refresh_view = function()
-  if state.settings.discussion_sign.enabled then
-    signs.refresh_signs(M.discussions)
-  end
-  if state.settings.discussion_diagnostic.enabled then
-    signs.refresh_diagnostics(M.discussions)
+  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
@@ -168,7 +167,7 @@ M.toggle = function(callback)
     M.focused_bufnr = default_buffer
 
     M.switch_can_edit_bufs(false)
-    winbar.update_winbar(M.discussions, M.unlinked_discussions, default_discussions and "Discussions" or "Notes")
+    M.refresh_view()
 
     vim.api.nvim_set_current_win(current_window)
     if type(callback) == "function" then
@@ -198,7 +197,7 @@ 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 diagnostics = vim.diagnostic.get(0, { namespace = signs.diagnostics_namespace, lnum = current_line - 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)
@@ -229,11 +228,11 @@ M.move_to_discussion_tree = function()
     end
   end
 
-  if #diagnostics == 0 then
+  if #d == 0 then
     u.notify("No diagnostics for this line", vim.log.levels.WARN)
     return
-  elseif #diagnostics > 1 then
-    vim.ui.select(diagnostics, {
+  elseif #d > 1 then
+    vim.ui.select(d, {
       prompt = "Choose discussion to jump to",
       format_item = function(diagnostic)
         return diagnostic.message
@@ -245,7 +244,7 @@ M.move_to_discussion_tree = function()
       jump_after_menu_selection(diagnostic)
     end)
   else
-    jump_after_menu_selection(diagnostics[1])
+    jump_after_menu_selection(d[1])
   end
 end
 
@@ -389,7 +388,7 @@ 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 file_name, new_line, old_line, is_undefined_type, error = M.get_note_location(tree)
+  local file_name, new_line, old_line, error = M.get_note_location(tree)
   if error ~= nil then
     u.notify(error, vim.log.levels.ERROR)
     return
@@ -403,13 +402,13 @@ M.jump_to_reviewer = function(tree)
     return
   end
 
-  reviewer.jump(file_name, new_line_int, old_line_int, { is_undefined_type = is_undefined_type })
+  reviewer.jump(file_name, new_line_int, old_line_int)
   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 file_name, new_line, old_line, _, error = M.get_note_location(tree)
+  local file_name, new_line, old_line, error = M.get_note_location(tree)
   if error ~= nil then
     u.notify(error, vim.log.levels.ERROR)
     return
@@ -911,21 +910,17 @@ end
 
 ---Get note location
 ---@param tree NuiTree
----@return string, string, string, boolean, string?
+---@return string, string, string, string?
 M.get_note_location = function(tree)
   local node = tree:get_node()
   if node == nil then
-    return "", "", "", false, "Could not get node"
+    return "", "", "", "Could not get node"
   end
   local discussion_node = M.get_root_node(tree, node)
   if discussion_node == nil then
-    return "", "", "", false, "Could not get discussion node"
+    return "", "", "", "Could not get discussion node"
   end
-  return discussion_node.file_name,
-    discussion_node.new_line,
-    discussion_node.old_line,
-    discussion_node.undefined_type or false,
-    nil
+  return discussion_node.file_name, discussion_node.new_line, discussion_node.old_line, nil
 end
 
 ---@param tree NuiTree