mirror of
https://github.com/neovim/neovim.git
synced 2025-02-25 18:55:25 -06:00
chore: fix typos (#16506)
Co-authored-by: Gregory Anders <8965202+gpanders@users.noreply.github.com> Co-authored-by: Evgeni Chasnovski <evgeni.chasnovski@gmail.com> Co-authored-by: zeertzjq <zeertzjq@outlook.com> Co-authored-by: Christoph Hasse <hassec@users.noreply.github.com> Co-authored-by: Alef Pereira <ealefpereira@gmail.com> Co-authored-by: AusCyber <willp@outlook.com.au> Co-authored-by: kylo252 <59826753+kylo252@users.noreply.github.com>
This commit is contained in:
parent
2ff5189d68
commit
08616571f4
@ -523,7 +523,7 @@ function! s:check_virtualenv() abort
|
|||||||
let hint = '$PATH ambiguities in subshells typically are '
|
let hint = '$PATH ambiguities in subshells typically are '
|
||||||
\.'caused by your shell config overriding the $PATH previously set by the '
|
\.'caused by your shell config overriding the $PATH previously set by the '
|
||||||
\.'virtualenv. Either prevent them from doing so, or use this workaround: '
|
\.'virtualenv. Either prevent them from doing so, or use this workaround: '
|
||||||
\.'https://vi.stackexchange.com/a/7654'
|
\.'https://vi.stackexchange.com/a/34996'
|
||||||
let hints[hint] = v:true
|
let hints[hint] = v:true
|
||||||
endif
|
endif
|
||||||
endfor
|
endfor
|
||||||
|
@ -361,7 +361,7 @@ UTF-32 and UTF-16 sizes of the deleted region is also passed as additional
|
|||||||
arguments {old_utf32_size} and {old_utf16_size}.
|
arguments {old_utf32_size} and {old_utf16_size}.
|
||||||
|
|
||||||
"on_changedtick" is invoked when |b:changedtick| was incremented but no text
|
"on_changedtick" is invoked when |b:changedtick| was incremented but no text
|
||||||
was changed. The parameters recieved are ("changedtick", {buf}, {changedtick}).
|
was changed. The parameters received are ("changedtick", {buf}, {changedtick}).
|
||||||
|
|
||||||
*api-lua-detach*
|
*api-lua-detach*
|
||||||
In-process Lua callbacks can detach by returning `true`. This will detach all
|
In-process Lua callbacks can detach by returning `true`. This will detach all
|
||||||
@ -634,7 +634,7 @@ nvim_call_atomic({calls}) *nvim_call_atomic()*
|
|||||||
atomically, i.e. without interleaving redraws, RPC requests
|
atomically, i.e. without interleaving redraws, RPC requests
|
||||||
from other clients, or user interactions (however API
|
from other clients, or user interactions (however API
|
||||||
methods may trigger autocommands or event processing which
|
methods may trigger autocommands or event processing which
|
||||||
have such side-effects, e.g. |:sleep| may wake timers).
|
have such side effects, e.g. |:sleep| may wake timers).
|
||||||
2. To minimize RPC overhead (roundtrips) of a sequence of many
|
2. To minimize RPC overhead (roundtrips) of a sequence of many
|
||||||
requests.
|
requests.
|
||||||
|
|
||||||
@ -698,7 +698,7 @@ nvim_del_keymap({mode}, {lhs}) *nvim_del_keymap()*
|
|||||||
|nvim_set_keymap()|
|
|nvim_set_keymap()|
|
||||||
|
|
||||||
nvim_del_mark({name}) *nvim_del_mark()*
|
nvim_del_mark({name}) *nvim_del_mark()*
|
||||||
Deletes a uppercase/file named mark. See |mark-motions|.
|
Deletes an uppercase/file named mark. See |mark-motions|.
|
||||||
|
|
||||||
Note:
|
Note:
|
||||||
fails with error if a lowercase or buffer local named mark
|
fails with error if a lowercase or buffer local named mark
|
||||||
@ -1061,7 +1061,7 @@ nvim_get_option_value({name}, {*opts}) *nvim_get_option_value()*
|
|||||||
Parameters: ~
|
Parameters: ~
|
||||||
{name} Option name
|
{name} Option name
|
||||||
{opts} Optional parameters
|
{opts} Optional parameters
|
||||||
• scope: One of 'global' or 'local'. Analagous to
|
• scope: One of 'global' or 'local'. Analogous to
|
||||||
|:setglobal| and |:setlocal|, respectively.
|
|:setglobal| and |:setlocal|, respectively.
|
||||||
|
|
||||||
Return: ~
|
Return: ~
|
||||||
@ -1545,7 +1545,7 @@ nvim_set_option_value({name}, {value}, {*opts})
|
|||||||
{name} Option name
|
{name} Option name
|
||||||
{value} New option value
|
{value} New option value
|
||||||
{opts} Optional parameters
|
{opts} Optional parameters
|
||||||
• scope: One of 'global' or 'local'. Analagous to
|
• scope: One of 'global' or 'local'. Analogous to
|
||||||
|:setglobal| and |:setlocal|, respectively.
|
|:setglobal| and |:setlocal|, respectively.
|
||||||
|
|
||||||
nvim_set_var({name}, {value}) *nvim_set_var()*
|
nvim_set_var({name}, {value}) *nvim_set_var()*
|
||||||
@ -2687,7 +2687,7 @@ nvim_win_is_valid({window}) *nvim_win_is_valid()*
|
|||||||
true if the window is valid, false otherwise
|
true if the window is valid, false otherwise
|
||||||
|
|
||||||
nvim_win_set_buf({window}, {buffer}) *nvim_win_set_buf()*
|
nvim_win_set_buf({window}, {buffer}) *nvim_win_set_buf()*
|
||||||
Sets the current buffer in a window, without side-effects
|
Sets the current buffer in a window, without side effects
|
||||||
|
|
||||||
Attributes: ~
|
Attributes: ~
|
||||||
not allowed when |textlock| is active
|
not allowed when |textlock| is active
|
||||||
|
@ -132,7 +132,7 @@ with |vim.notify()|: >
|
|||||||
In this example, there is nothing to do when diagnostics are hidden, so we
|
In this example, there is nothing to do when diagnostics are hidden, so we
|
||||||
omit the "hide" function.
|
omit the "hide" function.
|
||||||
|
|
||||||
Existing handlers can be overriden. For example, use the following to only
|
Existing handlers can be overridden. For example, use the following to only
|
||||||
show a sign for the highest severity diagnostic on a given line: >
|
show a sign for the highest severity diagnostic on a given line: >
|
||||||
|
|
||||||
-- Create a custom namespace. This will aggregate signs from all other
|
-- Create a custom namespace. This will aggregate signs from all other
|
||||||
@ -177,8 +177,9 @@ All highlights defined for diagnostics begin with `Diagnostic` followed by
|
|||||||
the type of highlight (e.g., `Sign`, `Underline`, etc.) and the severity (e.g.
|
the type of highlight (e.g., `Sign`, `Underline`, etc.) and the severity (e.g.
|
||||||
`Error`, `Warn`, etc.)
|
`Error`, `Warn`, etc.)
|
||||||
|
|
||||||
Sign, underline and virtual text highlights (by default) are linked to their
|
By default, highlights for signs, floating windows, and virtual text are linked to the
|
||||||
corresponding default highlight.
|
corresponding default highlight. Underline highlights are not linked and use their
|
||||||
|
own default highlight groups.
|
||||||
|
|
||||||
For example, the default highlighting for |hl-DiagnosticSignError| is linked
|
For example, the default highlighting for |hl-DiagnosticSignError| is linked
|
||||||
to |hl-DiagnosticError|. To change the default (and therefore the linked
|
to |hl-DiagnosticError|. To change the default (and therefore the linked
|
||||||
@ -298,7 +299,6 @@ Example: >
|
|||||||
autocmd DiagnosticChanged * lua vim.diagnostic.setqflist({open = false })
|
autocmd DiagnosticChanged * lua vim.diagnostic.setqflist({open = false })
|
||||||
<
|
<
|
||||||
==============================================================================
|
==============================================================================
|
||||||
==============================================================================
|
|
||||||
Lua module: vim.diagnostic *diagnostic-api*
|
Lua module: vim.diagnostic *diagnostic-api*
|
||||||
|
|
||||||
config({opts}, {namespace}) *vim.diagnostic.config()*
|
config({opts}, {namespace}) *vim.diagnostic.config()*
|
||||||
@ -343,7 +343,10 @@ config({opts}, {namespace}) *vim.diagnostic.config()*
|
|||||||
|diagnostic-severity|
|
|diagnostic-severity|
|
||||||
|
|
||||||
• virtual_text: (default true) Use virtual
|
• virtual_text: (default true) Use virtual
|
||||||
text for diagnostics. Options:
|
text for diagnostics. If multiple
|
||||||
|
diagnostics are set for a namespace, one
|
||||||
|
prefix per diagnostic + the last diagnostic
|
||||||
|
message are shown. Options:
|
||||||
• severity: Only show virtual text for
|
• severity: Only show virtual text for
|
||||||
diagnostics matching the given severity
|
diagnostics matching the given severity
|
||||||
|diagnostic-severity|
|
|diagnostic-severity|
|
||||||
@ -353,6 +356,11 @@ config({opts}, {namespace}) *vim.diagnostic.config()*
|
|||||||
is more than one diagnostic source in the
|
is more than one diagnostic source in the
|
||||||
buffer. Otherwise, any truthy value means
|
buffer. Otherwise, any truthy value means
|
||||||
to always show the diagnostic source.
|
to always show the diagnostic source.
|
||||||
|
• spacing: (number) Amount of empty spaces
|
||||||
|
inserted at the beginning of the virtual
|
||||||
|
text.
|
||||||
|
• prefix: (string) Prepend diagnostic
|
||||||
|
message with prefix.
|
||||||
• format: (function) A function that takes
|
• format: (function) A function that takes
|
||||||
a diagnostic as input and returns a
|
a diagnostic as input and returns a
|
||||||
string. The return value is the text used
|
string. The return value is the text used
|
||||||
|
@ -214,7 +214,7 @@ For |lsp-request|, each |lsp-handler| has this signature: >
|
|||||||
request, a table with information about the error
|
request, a table with information about the error
|
||||||
is sent. Otherwise, it is `nil`. See |lsp-response|.
|
is sent. Otherwise, it is `nil`. See |lsp-response|.
|
||||||
{result} (Result | Params | nil)
|
{result} (Result | Params | nil)
|
||||||
When the language server is able to succesfully
|
When the language server is able to successfully
|
||||||
complete a request, this contains the `result` key
|
complete a request, this contains the `result` key
|
||||||
of the response. See |lsp-response|.
|
of the response. See |lsp-response|.
|
||||||
{ctx} (table)
|
{ctx} (table)
|
||||||
@ -236,7 +236,7 @@ For |lsp-request|, each |lsp-handler| has this signature: >
|
|||||||
{config} (table)
|
{config} (table)
|
||||||
Configuration for the handler.
|
Configuration for the handler.
|
||||||
|
|
||||||
Each handler can define it's own configuration
|
Each handler can define its own configuration
|
||||||
table that allows users to customize the behavior
|
table that allows users to customize the behavior
|
||||||
of a particular handler.
|
of a particular handler.
|
||||||
|
|
||||||
@ -274,7 +274,7 @@ For |lsp-notification|, each |lsp-handler| has this signature: >
|
|||||||
{config} (table)
|
{config} (table)
|
||||||
Configuration for the handler.
|
Configuration for the handler.
|
||||||
|
|
||||||
Each handler can define it's own configuration
|
Each handler can define its own configuration
|
||||||
table that allows users to customize the behavior
|
table that allows users to customize the behavior
|
||||||
of a particular handler.
|
of a particular handler.
|
||||||
|
|
||||||
@ -369,7 +369,7 @@ Handlers can be set by:
|
|||||||
For example: >
|
For example: >
|
||||||
|
|
||||||
vim.lsp.start_client {
|
vim.lsp.start_client {
|
||||||
..., -- Other configuration ommitted.
|
..., -- Other configuration omitted.
|
||||||
handlers = {
|
handlers = {
|
||||||
["textDocument/definition"] = my_custom_server_definition
|
["textDocument/definition"] = my_custom_server_definition
|
||||||
},
|
},
|
||||||
@ -394,6 +394,9 @@ in the following order:
|
|||||||
2. Handler defined in |vim.lsp.start_client()|, if any.
|
2. Handler defined in |vim.lsp.start_client()|, if any.
|
||||||
3. Handler defined in |vim.lsp.handlers|, if any.
|
3. Handler defined in |vim.lsp.handlers|, if any.
|
||||||
|
|
||||||
|
*vim.lsp.log_levels*
|
||||||
|
Log levels are defined in |vim.log.levels|
|
||||||
|
|
||||||
|
|
||||||
VIM.LSP.PROTOCOL *vim.lsp.protocol*
|
VIM.LSP.PROTOCOL *vim.lsp.protocol*
|
||||||
|
|
||||||
@ -444,7 +447,7 @@ LspCodeLens
|
|||||||
|nvim_buf_set_extmark()|.
|
|nvim_buf_set_extmark()|.
|
||||||
|
|
||||||
LspCodeLensSeparator *hl-LspCodeLensSeparator*
|
LspCodeLensSeparator *hl-LspCodeLensSeparator*
|
||||||
Used to color the seperator between two or more code lens.
|
Used to color the separator between two or more code lens.
|
||||||
|
|
||||||
*lsp-highlight-signature*
|
*lsp-highlight-signature*
|
||||||
|
|
||||||
@ -835,10 +838,10 @@ start_client({config}) *vim.lsp.start_client()*
|
|||||||
throws an error. `code` is a number
|
throws an error. `code` is a number
|
||||||
describing the error. Other arguments
|
describing the error. Other arguments
|
||||||
may be passed depending on the error
|
may be passed depending on the error
|
||||||
kind. See |vim.lsp.client_errors| for
|
kind. See |vim.lsp.rpc.client_errors|
|
||||||
possible errors. Use
|
for possible errors. Use
|
||||||
`vim.lsp.client_errors[code]` to get
|
`vim.lsp.rpc.client_errors[code]` to
|
||||||
human-friendly name.
|
get human-friendly name.
|
||||||
{before_init} Callback with parameters
|
{before_init} Callback with parameters
|
||||||
(initialize_params, config) invoked
|
(initialize_params, config) invoked
|
||||||
before the LSP "initialize" phase,
|
before the LSP "initialize" phase,
|
||||||
@ -1301,7 +1304,7 @@ hover({_}, {result}, {ctx}, {config}) *vim.lsp.handlers.hover()*
|
|||||||
{config} table Configuration table.
|
{config} table Configuration table.
|
||||||
• border: (default=nil)
|
• border: (default=nil)
|
||||||
• Add borders to the floating window
|
• Add borders to the floating window
|
||||||
• See |vim.api.nvim_open_win()|
|
• See |nvim_open_win()|
|
||||||
|
|
||||||
*vim.lsp.handlers.signature_help()*
|
*vim.lsp.handlers.signature_help()*
|
||||||
signature_help({_}, {result}, {ctx}, {config})
|
signature_help({_}, {result}, {ctx}, {config})
|
||||||
|
@ -791,9 +791,9 @@ vim.stricmp({a}, {b}) *vim.stricmp()*
|
|||||||
respectively.
|
respectively.
|
||||||
|
|
||||||
vim.str_utfindex({str}[, {index}]) *vim.str_utfindex()*
|
vim.str_utfindex({str}[, {index}]) *vim.str_utfindex()*
|
||||||
Convert byte index to UTF-32 and UTF-16 indicies. If {index} is not
|
Convert byte index to UTF-32 and UTF-16 indices. If {index} is not
|
||||||
supplied, the length of the string is used. All indicies are zero-based.
|
supplied, the length of the string is used. All indices are zero-based.
|
||||||
Returns two values: the UTF-32 and UTF-16 indicies respectively.
|
Returns two values: the UTF-32 and UTF-16 indices respectively.
|
||||||
|
|
||||||
Embedded NUL bytes are treated as terminating the string. Invalid
|
Embedded NUL bytes are treated as terminating the string. Invalid
|
||||||
UTF-8 bytes, and embedded surrogates are counted as one code
|
UTF-8 bytes, and embedded surrogates are counted as one code
|
||||||
@ -913,6 +913,15 @@ vim.types *vim.types*
|
|||||||
`vim.types.dictionary` will not change or that `vim.types` table will
|
`vim.types.dictionary` will not change or that `vim.types` table will
|
||||||
only contain values for these three types.
|
only contain values for these three types.
|
||||||
|
|
||||||
|
*log_levels* *vim.log.levels*
|
||||||
|
Log levels are one of the values defined in `vim.log.levels`:
|
||||||
|
|
||||||
|
vim.log.levels.DEBUG
|
||||||
|
vim.log.levels.ERROR
|
||||||
|
vim.log.levels.INFO
|
||||||
|
vim.log.levels.TRACE
|
||||||
|
vim.log.levels.WARN
|
||||||
|
|
||||||
------------------------------------------------------------------------------
|
------------------------------------------------------------------------------
|
||||||
LUA-VIMSCRIPT BRIDGE *lua-vimscript*
|
LUA-VIMSCRIPT BRIDGE *lua-vimscript*
|
||||||
|
|
||||||
|
@ -90,7 +90,7 @@ Mouse input has the following behavior:
|
|||||||
- If another window is clicked, terminal focus will be lost and nvim will jump
|
- If another window is clicked, terminal focus will be lost and nvim will jump
|
||||||
to the clicked window
|
to the clicked window
|
||||||
- If the mouse wheel is used while the mouse is positioned in another window,
|
- If the mouse wheel is used while the mouse is positioned in another window,
|
||||||
the terminal wont lose focus and the hovered window will be scrolled.
|
the terminal won't lose focus and the hovered window will be scrolled.
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
Configuration *terminal-config*
|
Configuration *terminal-config*
|
||||||
@ -428,7 +428,7 @@ When 'background' is "dark":
|
|||||||
hi debugBreakpoint term=reverse ctermbg=red guibg=red
|
hi debugBreakpoint term=reverse ctermbg=red guibg=red
|
||||||
|
|
||||||
|
|
||||||
Shorcuts *termdebug_shortcuts*
|
Shortcuts *termdebug_shortcuts*
|
||||||
|
|
||||||
You can define your own shortcuts (mappings) to control gdb, that can work in
|
You can define your own shortcuts (mappings) to control gdb, that can work in
|
||||||
any window, using the TermDebugSendCommand() function. Example: >
|
any window, using the TermDebugSendCommand() function. Example: >
|
||||||
|
@ -100,7 +100,7 @@ tsnode:prev_named_sibling() *tsnode:prev_named_sibling()*
|
|||||||
|
|
||||||
tsnode:iter_children() *tsnode:iter_children()*
|
tsnode:iter_children() *tsnode:iter_children()*
|
||||||
Iterates over all the direct children of {tsnode}, regardless of
|
Iterates over all the direct children of {tsnode}, regardless of
|
||||||
wether they are named or not.
|
whether they are named or not.
|
||||||
Returns the child node plus the eventual field name corresponding to
|
Returns the child node plus the eventual field name corresponding to
|
||||||
this child node.
|
this child node.
|
||||||
|
|
||||||
@ -155,9 +155,9 @@ tsnode:sexpr() *tsnode:sexpr()*
|
|||||||
Get an S-expression representing the node as a string.
|
Get an S-expression representing the node as a string.
|
||||||
|
|
||||||
tsnode:id() *tsnode:id()*
|
tsnode:id() *tsnode:id()*
|
||||||
Get an unique identier for the node inside its own tree.
|
Get an unique identifier for the node inside its own tree.
|
||||||
|
|
||||||
No guarantees are made about this identifer's internal representation,
|
No guarantees are made about this identifier's internal representation,
|
||||||
except for being a primitive lua type with value equality (so not a table).
|
except for being a primitive lua type with value equality (so not a table).
|
||||||
Presently it is a (non-printable) string.
|
Presently it is a (non-printable) string.
|
||||||
|
|
||||||
@ -195,7 +195,7 @@ to a match.
|
|||||||
Treesitter Query Predicates *lua-treesitter-predicates*
|
Treesitter Query Predicates *lua-treesitter-predicates*
|
||||||
|
|
||||||
When writing queries for treesitter, one might use `predicates`, that is,
|
When writing queries for treesitter, one might use `predicates`, that is,
|
||||||
special scheme nodes that are evaluted to verify things on a captured node for
|
special scheme nodes that are evaluated to verify things on a captured node for
|
||||||
example, the |eq?| predicate : >
|
example, the |eq?| predicate : >
|
||||||
((identifier) @foo (#eq? @foo "foo"))
|
((identifier) @foo (#eq? @foo "foo"))
|
||||||
|
|
||||||
@ -203,7 +203,7 @@ This will only match identifier corresponding to the `"foo"` text.
|
|||||||
Here is a list of built-in predicates :
|
Here is a list of built-in predicates :
|
||||||
|
|
||||||
`eq?` *ts-predicate-eq?*
|
`eq?` *ts-predicate-eq?*
|
||||||
This predicate will check text correspondance between nodes or
|
This predicate will check text correspondence between nodes or
|
||||||
strings : >
|
strings : >
|
||||||
((identifier) @foo (#eq? @foo "foo"))
|
((identifier) @foo (#eq? @foo "foo"))
|
||||||
((node1) @left (node2) @right (#eq? @left @right))
|
((node1) @left (node2) @right (#eq? @left @right))
|
||||||
@ -212,7 +212,7 @@ Here is a list of built-in predicates :
|
|||||||
`vim-match?` *ts-predicate-vim-match?*
|
`vim-match?` *ts-predicate-vim-match?*
|
||||||
This will match if the provived vim regex matches the text
|
This will match if the provived vim regex matches the text
|
||||||
corresponding to a node : >
|
corresponding to a node : >
|
||||||
((idenfitier) @constant (#match? @constant "^[A-Z_]+$"))
|
((identifier) @constant (#match? @constant "^[A-Z_]+$"))
|
||||||
< Note: the `^` and `$` anchors will respectively match the
|
< Note: the `^` and `$` anchors will respectively match the
|
||||||
start and end of the node's text.
|
start and end of the node's text.
|
||||||
|
|
||||||
@ -267,7 +267,7 @@ Here is a list of built-in directives:
|
|||||||
`offset!` *ts-predicate-offset!*
|
`offset!` *ts-predicate-offset!*
|
||||||
Takes the range of the captured node and applies the offsets
|
Takes the range of the captured node and applies the offsets
|
||||||
to it's range : >
|
to it's range : >
|
||||||
((idenfitier) @constant (#offset! @constant 0 1 0 -1))
|
((identifier) @constant (#offset! @constant 0 1 0 -1))
|
||||||
< This will generate a range object for the captured node with the
|
< This will generate a range object for the captured node with the
|
||||||
offsets applied. The arguments are
|
offsets applied. The arguments are
|
||||||
`({capture_id}, {start_row}, {start_col}, {end_row}, {end_col}, {key?})`
|
`({capture_id}, {start_row}, {start_col}, {end_row}, {end_col}, {key?})`
|
||||||
|
@ -556,13 +556,19 @@ end
|
|||||||
--- - underline: (default true) Use underline for diagnostics. Options:
|
--- - underline: (default true) Use underline for diagnostics. Options:
|
||||||
--- * severity: Only underline diagnostics matching the given severity
|
--- * severity: Only underline diagnostics matching the given severity
|
||||||
--- |diagnostic-severity|
|
--- |diagnostic-severity|
|
||||||
--- - virtual_text: (default true) Use virtual text for diagnostics. Options:
|
--- - virtual_text: (default true) Use virtual text for diagnostics. If multiple diagnostics
|
||||||
|
--- are set for a namespace, one prefix per diagnostic + the last diagnostic
|
||||||
|
--- message are shown.
|
||||||
|
--- Options:
|
||||||
--- * severity: Only show virtual text for diagnostics matching the given
|
--- * severity: Only show virtual text for diagnostics matching the given
|
||||||
--- severity |diagnostic-severity|
|
--- severity |diagnostic-severity|
|
||||||
--- * source: (boolean or string) Include the diagnostic source in virtual
|
--- * source: (boolean or string) Include the diagnostic source in virtual
|
||||||
--- text. Use "if_many" to only show sources if there is more than
|
--- text. Use "if_many" to only show sources if there is more than
|
||||||
--- one diagnostic source in the buffer. Otherwise, any truthy value
|
--- one diagnostic source in the buffer. Otherwise, any truthy value
|
||||||
--- means to always show the diagnostic source.
|
--- means to always show the diagnostic source.
|
||||||
|
--- * spacing: (number) Amount of empty spaces inserted at the beginning
|
||||||
|
--- of the virtual text.
|
||||||
|
--- * prefix: (string) Prepend diagnostic message with prefix.
|
||||||
--- * format: (function) A function that takes a diagnostic as input and
|
--- * format: (function) A function that takes a diagnostic as input and
|
||||||
--- returns a string. The return value is the text used to display
|
--- returns a string. The return value is the text used to display
|
||||||
--- the diagnostic. Example:
|
--- the diagnostic. Example:
|
||||||
|
@ -290,7 +290,7 @@ end
|
|||||||
--- Memoizes a function. On first run, the function return value is saved and
|
--- Memoizes a function. On first run, the function return value is saved and
|
||||||
--- immediately returned on subsequent runs. If the function returns a multival,
|
--- immediately returned on subsequent runs. If the function returns a multival,
|
||||||
--- only the first returned value will be memoized and returned. The function will only be run once,
|
--- only the first returned value will be memoized and returned. The function will only be run once,
|
||||||
--- even if it has side-effects.
|
--- even if it has side effects.
|
||||||
---
|
---
|
||||||
---@param fn (function) Function to run
|
---@param fn (function) Function to run
|
||||||
---@returns (function) Memoized function
|
---@returns (function) Memoized function
|
||||||
@ -645,8 +645,8 @@ end
|
|||||||
---@param on_error Callback with parameters (code, ...), invoked
|
---@param on_error Callback with parameters (code, ...), invoked
|
||||||
--- when the client operation throws an error. `code` is a number describing
|
--- when the client operation throws an error. `code` is a number describing
|
||||||
--- the error. Other arguments may be passed depending on the error kind. See
|
--- the error. Other arguments may be passed depending on the error kind. See
|
||||||
--- |vim.lsp.client_errors| for possible errors.
|
--- |vim.lsp.rpc.client_errors| for possible errors.
|
||||||
--- Use `vim.lsp.client_errors[code]` to get human-friendly name.
|
--- Use `vim.lsp.rpc.client_errors[code]` to get human-friendly name.
|
||||||
---
|
---
|
||||||
---@param before_init Callback with parameters (initialize_params, config)
|
---@param before_init Callback with parameters (initialize_params, config)
|
||||||
--- invoked before the LSP "initialize" phase, where `params` contains the
|
--- invoked before the LSP "initialize" phase, where `params` contains the
|
||||||
@ -757,8 +757,8 @@ function lsp.start_client(config)
|
|||||||
---
|
---
|
||||||
---@param code (number) Error code
|
---@param code (number) Error code
|
||||||
---@param err (...) Other arguments may be passed depending on the error kind
|
---@param err (...) Other arguments may be passed depending on the error kind
|
||||||
---@see |vim.lsp.client_errors| for possible errors. Use
|
---@see |vim.lsp.rpc.client_errors| for possible errors. Use
|
||||||
---`vim.lsp.client_errors[code]` to get a human-friendly name.
|
---`vim.lsp.rpc.client_errors[code]` to get a human-friendly name.
|
||||||
function dispatch.on_error(code, err)
|
function dispatch.on_error(code, err)
|
||||||
local _ = log.error() and log.error(log_prefix, "on_error", { code = lsp.client_errors[code], err = err })
|
local _ = log.error() and log.error(log_prefix, "on_error", { code = lsp.client_errors[code], err = err })
|
||||||
err_message(log_prefix, ': Error ', lsp.client_errors[code], ': ', vim.inspect(err))
|
err_message(log_prefix, ': Error ', lsp.client_errors[code], ': ', vim.inspect(err))
|
||||||
@ -1708,14 +1708,14 @@ end
|
|||||||
--
|
--
|
||||||
-- Can be used to lookup the number from the name or the
|
-- Can be used to lookup the number from the name or the
|
||||||
-- name from the number.
|
-- name from the number.
|
||||||
-- Levels by name: "trace", "debug", "info", "warn", "error"
|
-- Levels by name: "TRACE", "DEBUG", "INFO", "WARN", "ERROR"
|
||||||
-- Level numbers begin with "trace" at 0
|
-- Level numbers begin with "TRACE" at 0
|
||||||
lsp.log_levels = log.levels
|
lsp.log_levels = log.levels
|
||||||
|
|
||||||
--- Sets the global log level for LSP logging.
|
--- Sets the global log level for LSP logging.
|
||||||
---
|
---
|
||||||
--- Levels by name: "trace", "debug", "info", "warn", "error"
|
--- Levels by name: "TRACE", "DEBUG", "INFO", "WARN", "ERROR"
|
||||||
--- Level numbers begin with "trace" at 0
|
--- Level numbers begin with "TRACE" at 0
|
||||||
---
|
---
|
||||||
--- Use `lsp.log_levels` for reverse lookup.
|
--- Use `lsp.log_levels` for reverse lookup.
|
||||||
---
|
---
|
||||||
|
@ -246,7 +246,7 @@ end
|
|||||||
---@param config table Configuration table.
|
---@param config table Configuration table.
|
||||||
--- - border: (default=nil)
|
--- - border: (default=nil)
|
||||||
--- - Add borders to the floating window
|
--- - Add borders to the floating window
|
||||||
--- - See |vim.api.nvim_open_win()|
|
--- - See |nvim_open_win()|
|
||||||
function M.hover(_, result, ctx, config)
|
function M.hover(_, result, ctx, config)
|
||||||
config = config or {}
|
config = config or {}
|
||||||
config.focus_id = ctx.method
|
config.focus_id = ctx.method
|
||||||
|
@ -8,8 +8,8 @@ local log = {}
|
|||||||
-- Log level dictionary with reverse lookup as well.
|
-- Log level dictionary with reverse lookup as well.
|
||||||
--
|
--
|
||||||
-- Can be used to lookup the number from the name or the name from the number.
|
-- Can be used to lookup the number from the name or the name from the number.
|
||||||
-- Levels by name: 'trace', 'debug', 'info', 'warn', 'error'
|
-- Levels by name: "TRACE", "DEBUG", "INFO", "WARN", "ERROR"
|
||||||
-- Level numbers begin with 'trace' at 0
|
-- Level numbers begin with "TRACE" at 0
|
||||||
log.levels = vim.deepcopy(vim.log.levels)
|
log.levels = vim.deepcopy(vim.log.levels)
|
||||||
|
|
||||||
-- Default log level is warn.
|
-- Default log level is warn.
|
||||||
|
@ -133,7 +133,8 @@ local function request_parser_loop()
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
local client_errors = vim.tbl_add_reverse_lookup {
|
--- Mapping of error codes used by the client
|
||||||
|
local client_errors = {
|
||||||
INVALID_SERVER_MESSAGE = 1;
|
INVALID_SERVER_MESSAGE = 1;
|
||||||
INVALID_SERVER_JSON = 2;
|
INVALID_SERVER_JSON = 2;
|
||||||
NO_RESULT_CALLBACK_FOUND = 3;
|
NO_RESULT_CALLBACK_FOUND = 3;
|
||||||
@ -143,6 +144,8 @@ local client_errors = vim.tbl_add_reverse_lookup {
|
|||||||
SERVER_RESULT_CALLBACK_ERROR = 7;
|
SERVER_RESULT_CALLBACK_ERROR = 7;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
client_errors = vim.tbl_add_reverse_lookup(client_errors)
|
||||||
|
|
||||||
--- Constructs an error message from an LSP error object.
|
--- Constructs an error message from an LSP error object.
|
||||||
---
|
---
|
||||||
---@param err (table) The error object
|
---@param err (table) The error object
|
||||||
|
@ -662,7 +662,7 @@ Object nvim_get_option(String name, Error *err)
|
|||||||
///
|
///
|
||||||
/// @param name Option name
|
/// @param name Option name
|
||||||
/// @param opts Optional parameters
|
/// @param opts Optional parameters
|
||||||
/// - scope: One of 'global' or 'local'. Analagous to
|
/// - scope: One of 'global' or 'local'. Analogous to
|
||||||
/// |:setglobal| and |:setlocal|, respectively.
|
/// |:setglobal| and |:setlocal|, respectively.
|
||||||
/// @param[out] err Error details, if any
|
/// @param[out] err Error details, if any
|
||||||
/// @return Option value
|
/// @return Option value
|
||||||
@ -724,7 +724,7 @@ end:
|
|||||||
/// @param name Option name
|
/// @param name Option name
|
||||||
/// @param value New option value
|
/// @param value New option value
|
||||||
/// @param opts Optional parameters
|
/// @param opts Optional parameters
|
||||||
/// - scope: One of 'global' or 'local'. Analagous to
|
/// - scope: One of 'global' or 'local'. Analogous to
|
||||||
/// |:setglobal| and |:setlocal|, respectively.
|
/// |:setglobal| and |:setlocal|, respectively.
|
||||||
/// @param[out] err Error details, if any
|
/// @param[out] err Error details, if any
|
||||||
void nvim_set_option_value(String name, Object value, Dict(option) *opts, Error *err)
|
void nvim_set_option_value(String name, Object value, Dict(option) *opts, Error *err)
|
||||||
@ -1741,7 +1741,7 @@ Array nvim_list_chans(void)
|
|||||||
/// 1. To perform several requests from an async context atomically, i.e.
|
/// 1. To perform several requests from an async context atomically, i.e.
|
||||||
/// without interleaving redraws, RPC requests from other clients, or user
|
/// without interleaving redraws, RPC requests from other clients, or user
|
||||||
/// interactions (however API methods may trigger autocommands or event
|
/// interactions (however API methods may trigger autocommands or event
|
||||||
/// processing which have such side-effects, e.g. |:sleep| may wake timers).
|
/// processing which have such side effects, e.g. |:sleep| may wake timers).
|
||||||
/// 2. To minimize RPC overhead (roundtrips) of a sequence of many requests.
|
/// 2. To minimize RPC overhead (roundtrips) of a sequence of many requests.
|
||||||
///
|
///
|
||||||
/// @param channel_id
|
/// @param channel_id
|
||||||
@ -2101,7 +2101,7 @@ void nvim__screenshot(String path)
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/// Deletes a uppercase/file named mark. See |mark-motions|.
|
/// Deletes an uppercase/file named mark. See |mark-motions|.
|
||||||
///
|
///
|
||||||
/// @note fails with error if a lowercase or buffer local named mark is used.
|
/// @note fails with error if a lowercase or buffer local named mark is used.
|
||||||
/// @param name Mark name
|
/// @param name Mark name
|
||||||
|
@ -39,7 +39,7 @@ Buffer nvim_win_get_buf(Window window, Error *err)
|
|||||||
return win->w_buffer->handle;
|
return win->w_buffer->handle;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Sets the current buffer in a window, without side-effects
|
/// Sets the current buffer in a window, without side effects
|
||||||
///
|
///
|
||||||
/// @param window Window handle, or 0 for current window
|
/// @param window Window handle, or 0 for current window
|
||||||
/// @param buffer Buffer handle
|
/// @param buffer Buffer handle
|
||||||
|
@ -75,7 +75,7 @@ bool loop_poll_events(Loop *loop, int ms)
|
|||||||
/// @note Event is queued into `fast_events`, which is processed outside of the
|
/// @note Event is queued into `fast_events`, which is processed outside of the
|
||||||
/// primary `events` queue by loop_poll_events(). For `main_loop`, that
|
/// primary `events` queue by loop_poll_events(). For `main_loop`, that
|
||||||
/// means `fast_events` is NOT processed in an "editor mode"
|
/// means `fast_events` is NOT processed in an "editor mode"
|
||||||
/// (VimState.execute), so redraw and other side-effects are likely to be
|
/// (VimState.execute), so redraw and other side effects are likely to be
|
||||||
/// skipped.
|
/// skipped.
|
||||||
/// @see loop_schedule_deferred
|
/// @see loop_schedule_deferred
|
||||||
void loop_schedule_fast(Loop *loop, Event event)
|
void loop_schedule_fast(Loop *loop, Event event)
|
||||||
|
@ -424,7 +424,7 @@ end
|
|||||||
--- Without a runtime, writes to :Messages
|
--- Without a runtime, writes to :Messages
|
||||||
---@see :help nvim_notify
|
---@see :help nvim_notify
|
||||||
---@param msg string Content of the notification to show to the user
|
---@param msg string Content of the notification to show to the user
|
||||||
---@param log_level number|nil enum from vim.log.levels
|
---@param log_level number|nil enum from |vim.log.levels|
|
||||||
---@param opts table|nil additional options (timeout, etc)
|
---@param opts table|nil additional options (timeout, etc)
|
||||||
function vim.notify(msg, log_level, opts) -- luacheck: no unused
|
function vim.notify(msg, log_level, opts) -- luacheck: no unused
|
||||||
if log_level == vim.log.levels.ERROR then
|
if log_level == vim.log.levels.ERROR then
|
||||||
|
@ -1877,7 +1877,7 @@ static void patch_terminfo_bugs(TUIData *data, const char *term, const char *col
|
|||||||
"\x1b[?c");
|
"\x1b[?c");
|
||||||
} else if (konsolev > 0 && konsolev < 180770) {
|
} else if (konsolev > 0 && konsolev < 180770) {
|
||||||
// Konsole before version 18.07.70: set up a nonce profile. This has
|
// Konsole before version 18.07.70: set up a nonce profile. This has
|
||||||
// side-effects on temporary font resizing. #6798
|
// side effects on temporary font resizing. #6798
|
||||||
data->unibi_ext.set_cursor_style = (int)unibi_add_ext_str(ut, "Ss",
|
data->unibi_ext.set_cursor_style = (int)unibi_add_ext_str(ut, "Ss",
|
||||||
TMUX_WRAP(tmux,
|
TMUX_WRAP(tmux,
|
||||||
"\x1b]50;CursorShape=%?"
|
"\x1b]50;CursorShape=%?"
|
||||||
|
@ -38,7 +38,7 @@ Layout
|
|||||||
- `/test/functional` : functional tests
|
- `/test/functional` : functional tests
|
||||||
- `/test/unit` : unit tests
|
- `/test/unit` : unit tests
|
||||||
- `/test/config` : contains `*.in` files which are transformed into `*.lua`
|
- `/test/config` : contains `*.in` files which are transformed into `*.lua`
|
||||||
files using `configure_file` CMake command: this is for acessing CMake
|
files using `configure_file` CMake command: this is for accessing CMake
|
||||||
variables in lua tests.
|
variables in lua tests.
|
||||||
- `/test/includes` : include-files for use by luajit `ffi.cdef` C definitions
|
- `/test/includes` : include-files for use by luajit `ffi.cdef` C definitions
|
||||||
parser: normally used to make macros not accessible via this mechanism
|
parser: normally used to make macros not accessible via this mechanism
|
||||||
@ -197,7 +197,7 @@ Guidelines
|
|||||||
(success + fail + error + pending) is the same in all environments.
|
(success + fail + error + pending) is the same in all environments.
|
||||||
- *Note:* `pending()` is ignored if it is missing an argument, unless it is
|
- *Note:* `pending()` is ignored if it is missing an argument, unless it is
|
||||||
[contained in an `it()` block](https://github.com/neovim/neovim/blob/d21690a66e7eb5ebef18046c7a79ef898966d786/test/functional/ex_cmds/grep_spec.lua#L11).
|
[contained in an `it()` block](https://github.com/neovim/neovim/blob/d21690a66e7eb5ebef18046c7a79ef898966d786/test/functional/ex_cmds/grep_spec.lua#L11).
|
||||||
Provide empty function argument if the `pending()` call is outside of `it()`
|
Provide empty function argument if the `pending()` call is outside `it()`
|
||||||
([example](https://github.com/neovim/neovim/commit/5c1dc0fbe7388528875aff9d7b5055ad718014de#diff-bf80b24c724b0004e8418102f68b0679R18)).
|
([example](https://github.com/neovim/neovim/commit/5c1dc0fbe7388528875aff9d7b5055ad718014de#diff-bf80b24c724b0004e8418102f68b0679R18)).
|
||||||
- Really long `source([=[...]=])` blocks may break Vim's Lua syntax
|
- Really long `source([=[...]=])` blocks may break Vim's Lua syntax
|
||||||
highlighting. Try `:syntax sync fromstart` to fix it.
|
highlighting. Try `:syntax sync fromstart` to fix it.
|
||||||
|
Loading…
Reference in New Issue
Block a user