Regenerate nvim config
This commit is contained in:
@ -0,0 +1,305 @@
|
||||
*trouble.nvim.txt* For Neovim >= 0.8.0 Last change: 2024 May 19
|
||||
|
||||
==============================================================================
|
||||
Table of Contents *trouble.nvim-table-of-contents*
|
||||
|
||||
1. Trouble v3 Beta! |trouble.nvim-trouble-v3-beta!|
|
||||
2. Trouble v2 |trouble.nvim-trouble-v2|
|
||||
- Features |trouble.nvim-trouble-v2-features|
|
||||
- Requirements |trouble.nvim-trouble-v2-requirements|
|
||||
- Installation |trouble.nvim-trouble-v2-installation|
|
||||
- Configuration |trouble.nvim-trouble-v2-configuration|
|
||||
- Usage |trouble.nvim-trouble-v2-usage|
|
||||
- Colors |trouble.nvim-trouble-v2-colors|
|
||||
3. Links |trouble.nvim-links|
|
||||
|
||||
==============================================================================
|
||||
1. Trouble v3 Beta! *trouble.nvim-trouble-v3-beta!*
|
||||
|
||||
**Trouble**has been rewritten from scratch. If you’d like to try the new
|
||||
version, please refer to the beta docs
|
||||
<https://github.com/folke/trouble.nvim/tree/dev>
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
==============================================================================
|
||||
2. Trouble v2 *trouble.nvim-trouble-v2*
|
||||
|
||||
A pretty list for showing diagnostics, references, telescope results, quickfix
|
||||
and location lists to help you solve all the trouble your code is causing.
|
||||
|
||||
|
||||
FEATURES *trouble.nvim-trouble-v2-features*
|
||||
|
||||
- pretty list of:
|
||||
- Diagnostics
|
||||
- LSP references
|
||||
- LSP implementations
|
||||
- LSP definitions
|
||||
- LSP type definitions
|
||||
- quickfix list
|
||||
- location list
|
||||
- Telescope <https://github.com/nvim-telescope/telescope.nvim> search results
|
||||
- automatically updates on new diagnostics
|
||||
- toggle **diagnostics** mode between **workspace** or **document**
|
||||
- **interactive preview** in your last accessed window
|
||||
- _cancel_ preview or _jump_ to the location
|
||||
- configurable actions, signs, highlights,…
|
||||
|
||||
|
||||
REQUIREMENTS *trouble.nvim-trouble-v2-requirements*
|
||||
|
||||
- Neovim >= 0.7.2
|
||||
- Properly configured Neovim LSP client
|
||||
- nvim-web-devicons <https://github.com/nvim-tree/nvim-web-devicons> is optional to enable file icons
|
||||
- a theme with properly configured highlight groups for Neovim Diagnostics
|
||||
- or install lsp-colors <https://github.com/folke/lsp-colors.nvim> to automatically create the missing highlight groups
|
||||
- a patched font <https://www.nerdfonts.com/> for the default severity and fold icons
|
||||
|
||||
|
||||
INSTALLATION *trouble.nvim-trouble-v2-installation*
|
||||
|
||||
Install the plugin with your preferred package manager:
|
||||
|
||||
|
||||
LAZY.NVIM ~
|
||||
|
||||
>lua
|
||||
return {
|
||||
"folke/trouble.nvim",
|
||||
dependencies = { "nvim-tree/nvim-web-devicons" },
|
||||
opts = {
|
||||
-- your configuration comes here
|
||||
-- or leave it empty to use the default settings
|
||||
-- refer to the configuration section below
|
||||
},
|
||||
}
|
||||
<
|
||||
|
||||
|
||||
CONFIGURATION *trouble.nvim-trouble-v2-configuration*
|
||||
|
||||
|
||||
SETUP ~
|
||||
|
||||
Trouble comes with the following defaults:
|
||||
|
||||
>lua
|
||||
{
|
||||
position = "bottom", -- position of the list can be: bottom, top, left, right
|
||||
height = 10, -- height of the trouble list when position is top or bottom
|
||||
width = 50, -- width of the list when position is left or right
|
||||
icons = true, -- use devicons for filenames
|
||||
mode = "workspace_diagnostics", -- "workspace_diagnostics", "document_diagnostics", "quickfix", "lsp_references", "loclist"
|
||||
severity = nil, -- nil (ALL) or vim.diagnostic.severity.ERROR | WARN | INFO | HINT
|
||||
fold_open = "", -- icon used for open folds
|
||||
fold_closed = "", -- icon used for closed folds
|
||||
group = true, -- group results by file
|
||||
padding = true, -- add an extra new line on top of the list
|
||||
cycle_results = true, -- cycle item list when reaching beginning or end of list
|
||||
action_keys = { -- key mappings for actions in the trouble list
|
||||
-- map to {} to remove a mapping, for example:
|
||||
-- close = {},
|
||||
close = "q", -- close the list
|
||||
cancel = "<esc>", -- cancel the preview and get back to your last window / buffer / cursor
|
||||
refresh = "r", -- manually refresh
|
||||
jump = { "<cr>", "<tab>", "<2-leftmouse>" }, -- jump to the diagnostic or open / close folds
|
||||
open_split = { "<c-x>" }, -- open buffer in new split
|
||||
open_vsplit = { "<c-v>" }, -- open buffer in new vsplit
|
||||
open_tab = { "<c-t>" }, -- open buffer in new tab
|
||||
jump_close = {"o"}, -- jump to the diagnostic and close the list
|
||||
toggle_mode = "m", -- toggle between "workspace" and "document" diagnostics mode
|
||||
switch_severity = "s", -- switch "diagnostics" severity filter level to HINT / INFO / WARN / ERROR
|
||||
toggle_preview = "P", -- toggle auto_preview
|
||||
hover = "K", -- opens a small popup with the full multiline message
|
||||
preview = "p", -- preview the diagnostic location
|
||||
open_code_href = "c", -- if present, open a URI with more information about the diagnostic error
|
||||
close_folds = {"zM", "zm"}, -- close all folds
|
||||
open_folds = {"zR", "zr"}, -- open all folds
|
||||
toggle_fold = {"zA", "za"}, -- toggle fold of current file
|
||||
previous = "k", -- previous item
|
||||
next = "j" -- next item
|
||||
help = "?" -- help menu
|
||||
},
|
||||
multiline = true, -- render multi-line messages
|
||||
indent_lines = true, -- add an indent guide below the fold icons
|
||||
win_config = { border = "single" }, -- window configuration for floating windows. See |nvim_open_win()|.
|
||||
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 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 = "",
|
||||
warning = "",
|
||||
hint = "",
|
||||
information = "",
|
||||
other = "",
|
||||
},
|
||||
use_diagnostic_signs = false -- enabling this will use the signs defined in your lsp client
|
||||
}
|
||||
<
|
||||
|
||||
|
||||
if you don’t want to use icons or a patched font, you can use the settings
|
||||
below
|
||||
>lua
|
||||
-- settings without a patched font or icons
|
||||
{
|
||||
icons = false,
|
||||
fold_open = "v", -- icon used for open folds
|
||||
fold_closed = ">", -- icon used for closed folds
|
||||
indent_lines = false, -- add an indent guide below the fold icons
|
||||
signs = {
|
||||
-- icons / text used for a diagnostic
|
||||
error = "error",
|
||||
warning = "warn",
|
||||
hint = "hint",
|
||||
information = "info"
|
||||
},
|
||||
use_diagnostic_signs = false -- enabling this will use the signs defined in your lsp client
|
||||
}
|
||||
<
|
||||
|
||||
|
||||
USAGE *trouble.nvim-trouble-v2-usage*
|
||||
|
||||
|
||||
COMMANDS ~
|
||||
|
||||
Trouble comes with the following commands:
|
||||
|
||||
- `Trouble [mode]`open the list
|
||||
- `TroubleClose [mode]`close the list
|
||||
- `TroubleToggle [mode]`toggle the list
|
||||
- `TroubleRefresh`manually refresh the active list
|
||||
|
||||
Modes:
|
||||
|
||||
- **document_diagnostics:** document diagnostics from the builtin LSP client
|
||||
- **workspace_diagnostics:** workspace diagnostics from the builtin LSP client
|
||||
- **lsp_references:** references of the word under the cursor from the builtin
|
||||
LSP client
|
||||
- **lsp_definitions:** definitions of the word under the cursor from the builtin
|
||||
LSP client
|
||||
- **lsp_type_definitions:** type definitions of the word under the cursor from
|
||||
the builtin LSP client
|
||||
- **quickfix:** |quickfix| items
|
||||
- **loclist:** items from the window’s |location list|
|
||||
|
||||
Example keybindings:
|
||||
|
||||
>vim
|
||||
" Vim Script
|
||||
nnoremap <leader>xx <cmd>TroubleToggle<cr>
|
||||
nnoremap <leader>xw <cmd>TroubleToggle workspace_diagnostics<cr>
|
||||
nnoremap <leader>xd <cmd>TroubleToggle document_diagnostics<cr>
|
||||
nnoremap <leader>xq <cmd>TroubleToggle quickfix<cr>
|
||||
nnoremap <leader>xl <cmd>TroubleToggle loclist<cr>
|
||||
nnoremap gR <cmd>TroubleToggle lsp_references<cr>
|
||||
<
|
||||
|
||||
>lua
|
||||
-- Lua
|
||||
vim.keymap.set("n", "<leader>xx", function() require("trouble").toggle() end)
|
||||
vim.keymap.set("n", "<leader>xw", function() require("trouble").toggle("workspace_diagnostics") end)
|
||||
vim.keymap.set("n", "<leader>xd", function() require("trouble").toggle("document_diagnostics") end)
|
||||
vim.keymap.set("n", "<leader>xq", function() require("trouble").toggle("quickfix") end)
|
||||
vim.keymap.set("n", "<leader>xl", function() require("trouble").toggle("loclist") end)
|
||||
vim.keymap.set("n", "gR", function() require("trouble").toggle("lsp_references") end)
|
||||
<
|
||||
|
||||
|
||||
API ~
|
||||
|
||||
You can use the following functions in your keybindings:
|
||||
|
||||
>lua
|
||||
-- toggle trouble with optional mode
|
||||
require("trouble").toggle(mode?)
|
||||
|
||||
-- open trouble with optional mode
|
||||
require("trouble").open(mode?)
|
||||
|
||||
-- close trouble
|
||||
require("trouble").close()
|
||||
|
||||
-- jump to the next item, skipping the groups
|
||||
require("trouble").next({skip_groups = true, jump = true});
|
||||
|
||||
-- jump to the previous item, skipping the groups
|
||||
require("trouble").previous({skip_groups = true, jump = true});
|
||||
|
||||
-- jump to the first item, skipping the groups
|
||||
require("trouble").first({skip_groups = true, jump = true});
|
||||
|
||||
-- jump to the last item, skipping the groups
|
||||
require("trouble").last({skip_groups = true, jump = true});
|
||||
<
|
||||
|
||||
|
||||
TELESCOPE ~
|
||||
|
||||
You can easily open any search results in **Trouble**, by defining a custom
|
||||
action:
|
||||
|
||||
>lua
|
||||
local actions = require("telescope.actions")
|
||||
local trouble = require("trouble.providers.telescope")
|
||||
|
||||
local telescope = require("telescope")
|
||||
|
||||
telescope.setup {
|
||||
defaults = {
|
||||
mappings = {
|
||||
i = { ["<c-t>"] = trouble.open_with_trouble },
|
||||
n = { ["<c-t>"] = trouble.open_with_trouble },
|
||||
},
|
||||
},
|
||||
}
|
||||
<
|
||||
|
||||
When you open telescope, you can now hit `<c-t>` to open the results in
|
||||
**Trouble**
|
||||
|
||||
|
||||
COLORS *trouble.nvim-trouble-v2-colors*
|
||||
|
||||
The table below shows all the highlight groups defined for Trouble.
|
||||
|
||||
Highlight Group
|
||||
------------------------
|
||||
TroubleCount
|
||||
TroubleError
|
||||
TroubleNormal
|
||||
TroubleTextInformation
|
||||
TroubleSignWarning
|
||||
TroubleLocation
|
||||
TroubleWarning
|
||||
TroublePreview
|
||||
TroubleTextError
|
||||
TroubleSignInformation
|
||||
TroubleIndent
|
||||
TroubleSource
|
||||
TroubleSignHint
|
||||
TroubleSignOther
|
||||
TroubleFoldIcon
|
||||
TroubleTextWarning
|
||||
TroubleCode
|
||||
TroubleInformation
|
||||
TroubleSignError
|
||||
TroubleFile
|
||||
TroubleHint
|
||||
TroubleTextHint
|
||||
TroubleText
|
||||
==============================================================================
|
||||
3. Links *trouble.nvim-links*
|
||||
|
||||
1. *image*: https://github.com/folke/trouble.nvim/assets/292349/481bc1f7-cb93-432d-8ab6-f54044334b96
|
||||
2. *LSP Trouble Screenshot*: ./media/shot.png
|
||||
|
||||
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
|
||||
|
||||
vim:tw=78:ts=8:noet:ft=help:norl:
|
||||
Reference in New Issue
Block a user