181 lines
9.2 KiB
Plaintext
181 lines
9.2 KiB
Plaintext
*symbols-outline.txt* For NVIM v0.5.0 Last change: 2022 September 15
|
||
|
||
==============================================================================
|
||
Table of Contents *symbols-outline-table-of-contents*
|
||
|
||
1. symbols-outline.nvim |symbols-outline-symbols-outline.nvim|
|
||
- Prerequisites |symbols-outline-prerequisites|
|
||
- Installation |symbols-outline-installation|
|
||
- Setup |symbols-outline-setup|
|
||
- Configuration |symbols-outline-configuration|
|
||
- Commands |symbols-outline-commands|
|
||
- Default keymaps |symbols-outline-default-keymaps|
|
||
- Highlights |symbols-outline-highlights|
|
||
|
||
==============================================================================
|
||
1. symbols-outline.nvim *symbols-outline-symbols-outline.nvim*
|
||
|
||
**A tree like view for symbols in Neovim using the Language Server Protocol.
|
||
Supports all your favourite languages.**
|
||
|
||
<div class="figure">
|
||
<img src="https://github.com/simrat39/rust-tools-demos/raw/master/symbols-demo.gif" title="fig:"/>
|
||
<p class="caption">demo</p>
|
||
</div>
|
||
|
||
PREREQUISITES *symbols-outline-prerequisites*
|
||
|
||
|
||
- `neovim 0.7+`
|
||
- Properly configured Neovim LSP client
|
||
|
||
|
||
INSTALLATION *symbols-outline-installation*
|
||
|
||
Using `packer.nvim`
|
||
|
||
>
|
||
use 'simrat39/symbols-outline.nvim'
|
||
<
|
||
|
||
|
||
SETUP *symbols-outline-setup*
|
||
|
||
Put the setup call in your init.lua or any lua file that is sourced.
|
||
|
||
>
|
||
require("symbols-outline").setup()
|
||
<
|
||
|
||
|
||
CONFIGURATION *symbols-outline-configuration*
|
||
|
||
Pass a table to the setup call above with your configuration options.
|
||
|
||
>
|
||
local opts = {
|
||
highlight_hovered_item = true,
|
||
show_guides = true,
|
||
auto_preview = false,
|
||
position = 'right',
|
||
relative_width = true,
|
||
width = 25,
|
||
auto_close = false,
|
||
show_numbers = false,
|
||
show_relative_numbers = false,
|
||
show_symbol_details = true,
|
||
preview_bg_highlight = 'Pmenu',
|
||
autofold_depth = nil,
|
||
auto_unfold_hover = true,
|
||
fold_markers = { '', '' },
|
||
wrap = false,
|
||
keymaps = { -- These keymaps can be a string or a table for multiple keys
|
||
close = {"<Esc>", "q"},
|
||
goto_location = "<Cr>",
|
||
focus_location = "o",
|
||
hover_symbol = "<C-space>",
|
||
toggle_preview = "K",
|
||
rename_symbol = "r",
|
||
code_actions = "a",
|
||
fold = "h",
|
||
unfold = "l",
|
||
fold_all = "W",
|
||
unfold_all = "E",
|
||
fold_reset = "R",
|
||
},
|
||
lsp_blacklist = {},
|
||
symbol_blacklist = {},
|
||
symbols = {
|
||
File = {icon = "", hl = "TSURI"},
|
||
Module = {icon = "", hl = "TSNamespace"},
|
||
Namespace = {icon = "", hl = "TSNamespace"},
|
||
Package = {icon = "", hl = "TSNamespace"},
|
||
Class = {icon = "𝓒", hl = "TSType"},
|
||
Method = {icon = "ƒ", hl = "TSMethod"},
|
||
Property = {icon = "", hl = "TSMethod"},
|
||
Field = {icon = "", hl = "TSField"},
|
||
Constructor = {icon = "", hl = "TSConstructor"},
|
||
Enum = {icon = "ℰ", hl = "TSType"},
|
||
Interface = {icon = "ﰮ", hl = "TSType"},
|
||
Function = {icon = "", hl = "TSFunction"},
|
||
Variable = {icon = "", hl = "TSConstant"},
|
||
Constant = {icon = "", hl = "TSConstant"},
|
||
String = {icon = "𝓐", hl = "TSString"},
|
||
Number = {icon = "#", hl = "TSNumber"},
|
||
Boolean = {icon = "⊨", hl = "TSBoolean"},
|
||
Array = {icon = "", hl = "TSConstant"},
|
||
Object = {icon = "⦿", hl = "TSType"},
|
||
Key = {icon = "🔐", hl = "TSType"},
|
||
Null = {icon = "NULL", hl = "TSType"},
|
||
EnumMember = {icon = "", hl = "TSField"},
|
||
Struct = {icon = "𝓢", hl = "TSType"},
|
||
Event = {icon = "🗲", hl = "TSType"},
|
||
Operator = {icon = "+", hl = "TSOperator"},
|
||
TypeParameter = {icon = "𝙏", hl = "TSParameter"}
|
||
}
|
||
}
|
||
<
|
||
|
||
|
||
│ Property │ Description │ Type │ Default │
|
||
│highlight_hovered_item│Whether to highlight the currently hovered symbol (high cpu usage) │boolean │true │
|
||
│show_guides │Whether to show outline guides │boolean │true │
|
||
│position │Where to open the split window │'right' or 'left' │'right' │
|
||
│relative_width │Whether width of window is set relative to existing windows │boolean │true │
|
||
│width │Width of window (as a % or columns based on relative_width) │int │25 │
|
||
│auto_close │Whether to automatically close the window after selection │boolean │false │
|
||
│auto_preview │Show a preview of the code on hover │boolean │false │
|
||
│show_numbers │Shows numbers with the outline │boolean │false │
|
||
│show_relative_numbers │Shows relative numbers with the outline │boolean │false │
|
||
│show_symbol_details │Shows extra details with the symbols (lsp dependent) │boolean │true │
|
||
│preview_bg_highlight │Background color of the preview window │string │Pmenu │
|
||
│winblend │Pseudo-transparency of the preview window │int │0 │
|
||
│keymaps │Which keys do what │table (dictionary)│|symbols-outline-here|│
|
||
│symbols │Icon and highlight config for symbol icons │table (dictionary)│scroll up │
|
||
│lsp_blacklist │Which lsp clients to ignore │table (array) │{} │
|
||
│symbol_blacklist │Which symbols to ignore (possible values <./lua/symbols-outline/symbols.lua>)│table (array) │{} │
|
||
│autofold_depth │Depth past which nodes will be folded by default │int │nil │
|
||
│auto_unfold_hover │Automatically unfold hovered symbol │boolean │true │
|
||
│fold_markers │Markers to denote foldable symbol’s status │table (array) │{ '', '' } │
|
||
│wrap │Whether to wrap long lines, or let them flow off the window │boolean │false │
|
||
|
||
|
||
COMMANDS *symbols-outline-commands*
|
||
|
||
│ Command │ Description │
|
||
│:SymbolsOutline │Toggle symbols outline│
|
||
│:SymbolsOutlineOpen │Open symbols outline │
|
||
│:SymbolsOutlineClose │Close symbols outline │
|
||
|
||
|
||
DEFAULT KEYMAPS *symbols-outline-default-keymaps*
|
||
|
||
│ Key │ Action │
|
||
│Escape │Close outline │
|
||
│Enter │Go to symbol location in code │
|
||
│o │Go to symbol location in code without losing focus│
|
||
│Ctrl+Space│Hover current symbol │
|
||
│K │Toggles the current symbol preview │
|
||
│r │Rename symbol │
|
||
│a │Code actions │
|
||
│h │Unfold symbol │
|
||
│l │Fold symbol │
|
||
│W │Fold all symbols │
|
||
│E │Unfold all symbols │
|
||
│R │Reset all folding │
|
||
│? │Show help message │
|
||
|
||
|
||
HIGHLIGHTS *symbols-outline-highlights*
|
||
|
||
│ Highlight │ Purpose │
|
||
│FocusedSymbol │Highlight of the focused symbol │
|
||
│Pmenu │Highlight of the preview popup windows│
|
||
│SymbolsOutlineConnector│Highlight of the table connectors │
|
||
│Comment │Highlight of the info virtual text │
|
||
|
||
|
||
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
|
||
|
||
vim:tw=78:ts=8:noet:ft=help:norl:
|