feat(diagnostics): additional filter options (#1610)

- root_dir. Useful to browse only project-scoped diagnostics.
- buflisted status. Useful to exclude diagnostics from unlisted buffers, which are created by language servers that analyze the entire project/workspace (e.g. sumneko-lua).

lua/telescope/builtin/diagnostics.lua

@@ -41,13 +41,23 @@ local diagnostics_to_tbl = function(opts)
     end
   end
 
+  opts.root_dir = opts.root_dir == true and vim.loop.cwd() or opts.root_dir
+
   local bufnr_name_map = {}
-  local preprocess_diag = function(diagnostic)
+  local filter_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 = {
+    local root_dir_test = not opts.root_dir
+      or string.sub(bufnr_name_map[diagnostic.bufnr], 1, #opts.root_dir) == opts.root_dir
+    local listed_test = not opts.no_unlisted or vim.api.nvim_buf_get_option(diagnostic.bufnr, "buflisted")
+
+    return root_dir_test and listed_test
+  end
+
+  local preprocess_diag = function(diagnostic)
+    return {
       bufnr = diagnostic.bufnr,
       filename = bufnr_name_map[diagnostic.bufnr],
       lnum = diagnostic.lnum + 1,
@@ -55,11 +65,12 @@ local diagnostics_to_tbl = function(opts)
       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))
+    if filter_diag(d) then
+      table.insert(items, preprocess_diag(d))
+    end
   end
 
   -- sort results by bufnr (prioritize cur buf), severity, lnum

lua/telescope/builtin/init.lua

@@ -426,7 +426,7 @@ builtin.lsp_dynamic_workspace_symbols = require_on_exported_call("telescope.buil
 --
 --
 
---- Lists diagnostics for current or all open buffers
+--- Lists diagnostics
 --- - Fields:
 ---   - `All severity flags can be passed as `string` or `number` as per `:vim.diagnostic.severity:`
 --- - Default keymaps:
@@ -436,6 +436,8 @@ builtin.lsp_dynamic_workspace_symbols = require_on_exported_call("telescope.buil
 ---@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 root_dir string|boolean: if set to string, get diagnostics only for buffers under this dir otherwise cwd
+---@field no_unlisted boolean: if true, get diagnostics only for listed buffers
 ---@field no_sign boolean: hide DiagnosticSigns from Results (default: false)
 ---@field line_width number: set length of diagnostic entry text in Results
 ---@field namespace number: limit your diagnostics to a specific namespace