feat: config for auto_preview

README.md

@@ -77,6 +77,8 @@ Trouble comes with the following defaults:
         refresh = "r", -- manually refresh
         jump = "<cr>", -- jump to the diagnostic or open / close folds
         toggle_mode = "m", -- toggle between "workspace" and "document" mode
+        toggle_preview = "P", -- toggle auto_preview
+        preview = "p", -- preview the diagnostic location
         close_folds = "zM", -- close all folds
         cancel = "<esc>", -- cancel the preview and get back to your last window / buffer / cursor
         open_folds = "zR", -- open all folds
@@ -86,6 +88,7 @@ Trouble comes with the following defaults:
     indent_lines = true, -- add an indent guide below the fold icons
     auto_open = false, -- automatically open the list when you have diagnostics
     auto_close = false, -- automatically close the list when you have no diagnostics
+    auto_preview = true, -- automatically preview the location of the diagnostic. <esc> to close preview and go back
     signs = {
         -- icons / text used for a diagnostic
         error = "",

lua/trouble/config.lua

@@ -14,6 +14,8 @@ local defaults = {
         refresh = "r", -- manually refresh
         jump = "<cr>", -- jump to the diagnostic or open / close folds
         toggle_mode = "m", -- toggle between "workspace" and "document" mode
+        toggle_preview = "P", -- toggle auto_preview
+        preview = "p", -- preview the diagnostic location
         close_folds = "zM", -- close all folds
         cancel = "<esc>", -- cancel the preview and get back to your last window / buffer / cursor
         open_folds = "zR", -- open all folds
@@ -23,6 +25,7 @@ local defaults = {
     indent_lines = true, -- add an indent guide below the fold icons
     auto_open = false, -- automatically open the list when you have diagnostics
     auto_close = false, -- automatically close the list when you have no diagnostics
+    auto_preview = true, -- automatyically preview the location of the diagnostic. <esc> to close preview and go back to last window
     signs = {
         -- icons / text used for a diagnostic
         error = "",

lua/trouble/init.lua

@@ -78,7 +78,19 @@ function Trouble.action(action)
     if action == "next" then view:next_item() end
     if action == "previous" then view:previous_item() end
 
+    if action == "toggle_preview" then
+        config.options.auto_preview = not config.options.auto_preview
+        if not config.options.auto_preview then
+            view:close_preview()
+        else
+            action = "preview"
+        end
+    end
+    if action == "auto_preview" and config.options.auto_preview then
+        action = "preview"
+    end
     if action == "preview" then view:preview() end
+
     if Trouble[action] then Trouble[action]() end
 end
 

lua/trouble/view.lua

@@ -143,7 +143,7 @@ function View:setup(opts)
     vim.api.nvim_exec([[
       augroup LspTroubleHighlights
         autocmd! * <buffer>
-        autocmd CursorMoved <buffer> nested lua require("trouble").action("preview")
+        autocmd CursorMoved <buffer> nested lua require("trouble").action("auto_preview")
         autocmd BufEnter <buffer> lua require("trouble").action("on_enter")
         autocmd BufLeave <buffer> lua require("trouble").action("on_leave")
       augroup END
@@ -164,12 +164,14 @@ function View:on_enter()
     }
 end
 
-function View:on_leave()
+function View:on_leave() self:close_preview() end
+
+function View:close_preview()
     -- Clear preview highlights
     for buf, _ in pairs(buffersHl) do clear_hl(buf) end
     buffersHl = {}
 
-    -- Reset parent stats
+    -- Reset parent state
     if self.parent_state then
         vim.api.nvim_win_set_buf(self.parent, self.parent_state.buf)
         vim.api.nvim_win_set_cursor(self.parent, self.parent_state.cursor)