feat: migrate to Telescope diagnostics using vim.diagnostic (#1553)

lua/telescope/builtin/diagnostics.lua

@@ -0,0 +1,129 @@
+local conf = require("telescope.config").values
+local finders = require "telescope.finders"
+local make_entry = require "telescope.make_entry"
+local pickers = require "telescope.pickers"
+
+local diagnostics = {}
+
+local convert_diagnostic_type = function(severities, severity)
+  -- convert from string to int
+  if type(severity) == "string" then
+    -- make sure that e.g. error is uppercased to ERROR
+    return severities[severity:upper()]
+  end
+  -- otherwise keep original value, incl. nil
+  return severity
+end
+
+local diagnostics_to_tbl = function(opts)
+  opts = vim.F.if_nil(opts, {})
+  local items = {}
+  local severities = vim.diagnostic.severity
+  local current_buf = vim.api.nvim_get_current_buf()
+
+  opts.severity = convert_diagnostic_type(severities, opts.severity)
+  opts.severity_limit = convert_diagnostic_type(severities, opts.severity_limit)
+  opts.severity_bound = convert_diagnostic_type(severities, opts.severity_bound)
+
+  local diagnosis_opts = { severity = {}, namespace = opts.namespace }
+  if opts.severity ~= nil then
+    if opts.severity_limit ~= nil or opts.severity_bound ~= nil then
+      print "Invalid severity parameters. Both a specific severity and a limit/bound is not allowed"
+      return {}
+    end
+    diagnosis_opts.severity = opts.severity
+  else
+    if opts.severity_limit ~= nil then
+      diagnosis_opts.severity["min"] = opts.severity_limit
+    end
+    if opts.severity_bound ~= nil then
+      diagnosis_opts.severity["max"] = opts.severity_bound
+    end
+  end
+
+  local bufnr_name_map = {}
+  local preprocess_diag = function(diagnostic)
+    if bufnr_name_map[diagnostic.bufnr] == nil then
+      bufnr_name_map[diagnostic.bufnr] = vim.api.nvim_buf_get_name(diagnostic.bufnr)
+    end
+
+    local buffer_diag = {
+      bufnr = diagnostic.bufnr,
+      filename = bufnr_name_map[diagnostic.bufnr],
+      lnum = diagnostic.lnum + 1,
+      col = diagnostic.col + 1,
+      text = vim.trim(diagnostic.message:gsub("[\n]", "")),
+      type = severities[diagnostic.severity] or severities[1],
+    }
+    return buffer_diag
+  end
+
+  for _, d in ipairs(vim.diagnostic.get(opts.bufnr, diagnosis_opts)) do
+    table.insert(items, preprocess_diag(d))
+  end
+
+  -- sort results by bufnr (prioritize cur buf), severity, lnum
+  table.sort(items, function(a, b)
+    if a.bufnr == b.bufnr then
+      if a.type == b.type then
+        return a.lnum < b.lnum
+      else
+        return a.type < b.type
+      end
+    else
+      -- prioritize for current bufnr
+      if a.bufnr == current_buf then
+        return true
+      end
+      if b.bufnr == current_buf then
+        return false
+      end
+      return a.bufnr < b.bufnr
+    end
+  end)
+
+  return items
+end
+
+diagnostics.get = function(opts)
+  if opts.bufnr == nil then
+    opts.path_display = vim.F.if_nil(opts.path_display, {})
+  end
+  if type(opts.bufnr) == "string" then
+    opts.bufnr = tonumber(opts.bufnr)
+  end
+
+  local locations = diagnostics_to_tbl(opts)
+
+  if vim.tbl_isempty(locations) then
+    print "No diagnostics found"
+    return
+  end
+
+  opts.path_display = vim.F.if_nil(opts.path_display, "hidden")
+  pickers.new(opts, {
+    prompt_title = "Document Diagnostics",
+    finder = finders.new_table {
+      results = locations,
+      entry_maker = opts.entry_maker or make_entry.gen_from_diagnostics(opts),
+    },
+    previewer = conf.qflist_previewer(opts),
+    sorter = conf.prefilter_sorter {
+      tag = "type",
+      sorter = conf.generic_sorter(opts),
+    },
+  }):find()
+end
+
+local function apply_checks(mod)
+  for k, v in pairs(mod) do
+    mod[k] = function(opts)
+      opts = opts or {}
+      v(opts)
+    end
+  end
+
+  return mod
+end
+
+return apply_checks(diagnostics)

lua/telescope/builtin/init.lua

@@ -436,31 +436,43 @@ builtin.lsp_workspace_symbols = require_on_exported_call("telescope.builtin.lsp"
 ---@field symbol_highlights table: string -> string. Matches symbol with hl_group
 builtin.lsp_dynamic_workspace_symbols = require_on_exported_call("telescope.builtin.lsp").dynamic_workspace_symbols
 
---- Lists LSP diagnostics for the current buffer
---- - Fields:
----   - `All severity flags can be passed as `string` or `number` as per `:vim.lsp.protocol.DiagnosticSeverity:`
---- - Default keymaps:
----   - `<C-l>`: show autocompletion menu to prefilter your query with the diagnostic you want to see (i.e. `:warning:`)
----@param opts table: options to pass to the picker
----@field severity string|number: filter diagnostics by severity name (string) or id (number)
----@field severity_limit string|number: keep diagnostics equal or more severe wrt severity name (string) or id (number)
----@field severity_bound string|number: keep diagnostics equal or less severe wrt severity name (string) or id (number)
----@field no_sign boolean: hide LspDiagnosticSigns from Results (default: false)
----@field line_width number: set length of diagnostic entry text in Results
-builtin.lsp_document_diagnostics = require_on_exported_call("telescope.builtin.lsp").diagnostics
+builtin.lsp_document_diagnostics = function(...)
+  vim.api.nvim_err_write(
+    "`lsp_document_diagnostics` is deprecated and will be removed. Please use `Telescope diagnostics bufnr=0`.\n"
+      .. "For more information see `:help telescope.changelog-1553`\n"
+  )
+  local new = ...
+  new.bufnr = 0
+  require("telescope.builtin.diagnostics").get(new)
+end
+builtin.lsp_workspace_diagnostics = function(...)
+  vim.api.nvim_err_write(
+    "`lsp_workspace_diagnostics` is deprecated and will be removed. Please use `Telescope diagnostics`.\n"
+      .. "For more information see `:help telescope.changelog-1553`\n"
+  )
+  require("telescope.builtin.diagnostics").get(...)
+end
 
---- Lists LSP diagnostics for the current workspace if supported, otherwise searches in all open buffers
+--
+--
+-- Diagnostics Pickers
+--
+--
+
+--- Lists diagnostics for current or all open buffers
 --- - Fields:
----   - `All severity flags can be passed as `string` or `number` as per `:vim.lsp.protocol.DiagnosticSeverity:`
+---   - `All severity flags can be passed as `string` or `number` as per `:vim.diagnostic.severity:`
 --- - Default keymaps:
 ---   - `<C-l>`: show autocompletion menu to prefilter your query with the diagnostic you want to see (i.e. `:warning:`)
 ---@param opts table: options to pass to the picker
+---@field bufnr string|number: if nil get diagnostics for all open buffers. Use 0 for current buffer
 ---@field severity string|number: filter diagnostics by severity name (string) or id (number)
 ---@field severity_limit string|number: keep diagnostics equal or more severe wrt severity name (string) or id (number)
 ---@field severity_bound string|number: keep diagnostics equal or less severe wrt severity name (string) or id (number)
----@field no_sign boolean: hide LspDiagnosticSigns from Results (default: false)
+---@field no_sign boolean: hide DiagnosticSigns from Results (default: false)
 ---@field line_width number: set length of diagnostic entry text in Results
-builtin.lsp_workspace_diagnostics = require_on_exported_call("telescope.builtin.lsp").workspace_diagnostics
+---@field namespace number: limit your diagnostics to a specific namespace
+builtin.diagnostics = require_on_exported_call("telescope.builtin.diagnostics").get
 
 local apply_config = function(mod)
   local pickers_conf = require("telescope.config").pickers

lua/telescope/builtin/lsp.lua

@@ -405,37 +405,6 @@ lsp.dynamic_workspace_symbols = function(opts)
   }):find()
 end
 
-lsp.diagnostics = function(opts)
-  local locations = utils.diagnostics_to_tbl(opts)
-
-  if vim.tbl_isempty(locations) then
-    print "No diagnostics found"
-    return
-  end
-
-  opts.path_display = utils.get_default(opts.path_display, "hidden")
-  pickers.new(opts, {
-    prompt_title = "LSP Document Diagnostics",
-    finder = finders.new_table {
-      results = locations,
-      entry_maker = opts.entry_maker or make_entry.gen_from_lsp_diagnostics(opts),
-    },
-    previewer = conf.qflist_previewer(opts),
-    sorter = conf.prefilter_sorter {
-      tag = "type",
-      sorter = conf.generic_sorter(opts),
-    },
-  }):find()
-end
-
-lsp.workspace_diagnostics = function(opts)
-  opts = utils.get_default(opts, {})
-  opts.path_display = utils.get_default(opts.path_display, {})
-  opts.prompt_title = "LSP Workspace Diagnostics"
-  opts.get_all = true
-  lsp.diagnostics(opts)
-end
-
 local function check_capabilities(feature)
   local clients = vim.lsp.buf_get_clients(0)