doc: update vimdocs for all the new options

This commit is contained in:
Steven Arcangeli 2021-11-20 18:34:11 -08:00
parent 2934e750ce
commit ff732ebe8d
3 changed files with 28 additions and 5 deletions

View file

@ -166,7 +166,7 @@ vim.g.aerial = {
},
treesitter = {
-- How long to wait after a buffer change before updating
-- How long to wait (in ms) after a buffer change before updating
update_delay = 300,
},
}

View file

@ -95,6 +95,18 @@ single dict. If using a single dict, remove the "aerial_" prefix.
\ 'min_width': 20,
\}
g:aerial_backends *g:aerial_backends*
Priority list of preferred backends for aerial. Built-in backends are "lsp"
and "treesitter". This can also be a |dict| mapping of filetypes. A key of
"_" will be used as the default if the filetype is not present.
>
let g:aerial_backends = {
\ '_': ["lsp", "treesitter"],
\ 'python': ["treesitter"],
\ 'rust': ["lsp"],
\}
g:aerial_close_behavior *g:aerial_close_behavior*
How to decide when to close the aerial window. Valid values are:
persist Remain open until manually closed
@ -122,14 +134,22 @@ g:aerial_placement_editor_edge *g:aerial_placement_editor_edge
behavior will open aerial as far right/left as possible while remaining
adjacent to a window containing the source buffer.
g:aerial_diagnostics_trigger_update *g:aerial_diagnostics_trigger_update*
g:aerial_lsp_diagnostics_trigger_update *g:aerial_lsp_diagnostics_trigger_update*
Call |vim.lsp.buf.document_symbol()| to update symbols whenenever the LSP
client receives diagnostics. Default `true`.
g:aerial_filter_kind *g:aerial_filter_kind*
A list of all |SymbolKind| values to display. Set to `false` to show all
symbols. Default is "Class", "Constructor", "Enum", "Function",
"Interface", "Method", and "Struct".
"Interface", "Method", and "Struct". This can also be a |dict| mapping of
filetypes. A key of "_" will be used as the default if the filetype is not
present.
>
let g:aerial_filter_kind = {
\ '_': ["Class", "Function", "Interface", "Method", "Struct"],
\ 'c': ["Namespace", "Function", "Struct", "Enum"],
\}
g:aerial_highlight_mode *g:aerial_highlight_mode*
Valid values are "split_width", "full_width", "last", or "none".
@ -204,9 +224,12 @@ g:aerial_post_jump_cmd *g:aerial_post_jump_cmd
Run this command after jumping to a symbol. Set to '' to disable.
Default "zvzz"
g:aerial_update_when_errors *g:aerial_update_when_errors*
g:aerial_lsp_update_when_errors *g:aerial_lsp_update_when_errors*
Update the aerial buffer even when your file has LSP errors. Default `true`.
g:aerial_treesitter_update_delay *g:aerial_treesitter_update_delay*
How long to wait (in ms) after a buffer change before updating.
g:aerial_icons *g:aerial_icons*
A map of |SymbolKind| to icons. You can also specify "<Symbol>Collapsed"
to change the icon when the tree is collapsed at this symbol, or

View file

@ -90,7 +90,7 @@ local default_options = {
},
treesitter = {
-- How long to wait after a buffer change before updating
-- How long to wait (in ms) after a buffer change before updating
update_delay = 300,
},
}