feat: Create Configuration for IncludeDeclaration (folke#312)

Previously, this setting was defaulted to true. Now, it will only
be set to true for modes that are explicitly named.

README.md

@@ -98,6 +98,7 @@ Trouble comes with the following defaults:
     auto_preview = true, -- automatically preview the location of the diagnostic. <esc> to close preview and go back to last window
     auto_fold = false, -- automatically fold a file trouble list at creation
     auto_jump = {"lsp_definitions"}, -- for the given modes, automatically jump if there is only a single result
+    include_declaration = { "lsp_references", "lsp_implementations", "lsp_definitions"  }, -- for the given modes, include the declaration of the current symbol in the results
     signs = {
       -- icons / text used for a diagnostic
       error = "",

doc/trouble.nvim.txt

@@ -117,6 +117,7 @@ Trouble comes with the following defaults:
         auto_preview = true, -- automatically preview the location of the diagnostic. <esc> to close preview and go back to last window
         auto_fold = false, -- automatically fold a file trouble list at creation
         auto_jump = {"lsp_definitions"}, -- for the given modes, automatically jump if there is only a single result
+	include_declaration = { "lsp_references", "lsp_implementations", "lsp_definitions"  }, -- for the given modes, include the declaration of the current symbol in the results
         signs = {
           -- icons / text used for a diagnostic
           error = "",

lua/trouble/config.lua

@@ -51,6 +51,7 @@ local defaults = {
   auto_preview = true, -- automatically preview the location of the diagnostic. <esc> to close preview and go back to last window
   auto_fold = false, -- automatically fold a file trouble list at creation
   auto_jump = { "lsp_definitions" }, -- for the given modes, automatically jump if there is only a single result
+  include_declaration = { "lsp_references", "lsp_implementations", "lsp_definitions"  }, -- for the given modes, include the declaration of the current symbol in the results
   signs = {
     -- icons / text used for a diagnostic
     error = "",

lua/trouble/providers/lsp.lua

@@ -11,10 +11,11 @@ local function lsp_buf_request(buf, method, params, handler)
 end
 
 ---@return Item[]
-function M.references(win, buf, cb, _options)
+function M.references(win, buf, cb, options)
   local method = "textDocument/references"
   local params = util.make_position_params(win, buf)
-  params.context = { includeDeclaration = true }
+  params.context = { includeDeclaration = vim.tbl_contains(options.include_declaration, options.mode) }
+
   lsp_buf_request(buf, method, params, function(err, result)
     if err then
       util.error("an error happened getting references: " .. err.message)
@@ -29,10 +30,10 @@ function M.references(win, buf, cb, _options)
 end
 
 ---@return Item[]
-function M.implementations(win, buf, cb, _options)
+function M.implementations(win, buf, cb, options)
   local method = "textDocument/implementation"
   local params = util.make_position_params(win, buf)
-  params.context = { includeDeclaration = true }
+  params.context = { includeDeclaration = vim.tbl_contains(options.include_declaration, options.mode) }
   lsp_buf_request(buf, method, params, function(err, result)
     if err then
       util.error("an error happened getting implementation: " .. err.message)
@@ -47,10 +48,10 @@ function M.implementations(win, buf, cb, _options)
 end
 
 ---@return Item[]
-function M.definitions(win, buf, cb, _options)
+function M.definitions(win, buf, cb, options)
   local method = "textDocument/definition"
   local params = util.make_position_params(win, buf)
-  params.context = { includeDeclaration = true }
+  params.context = { includeDeclaration = vim.tbl_contains(options.include_declaration, options.mode) }
   lsp_buf_request(buf, method, params, function(err, result)
     if err then
       util.error("an error happened getting definitions: " .. err.message)