Nvim:help pages,generated fromsource using thetree-sitter-vimdoc parser.
vim module namespace. Some of the plugins areloaded by default while others are not loaded until requested by:packadd.{left}{right}:DiffTool:packadd nvim.difftool beforeinvoking:DiffTool.git difftool -d integration usingDiffTool command:[difftool "nvim_difftool"] cmd = nvim -c \"packadd nvim.difftool\" -c \"DiffTool $LOCAL $REMOTE\"[diff] tool = nvim_difftool{left} (string){right} (string){opt} (table?){rename.detect} (boolean, default:false) Whether to detect renames{rename.similarity} (number, default:0.5) Minimum similarity for rename detection (0 to 1){rename.chunk_size} (number, default:4096) Maximum chunk size to read from files for similarity calculation{method} ('auto'|'builtin'|'diffr', default:auto) Diff method to use{ignore} (string[], default:{}) List of file patterns to ignore (for example:'.git', '*.log'){rename} (table) Controls rename detectionvim.g.editorconfig = falselet g:editorconfig = v:false). It can also be disabledper-buffer by setting theb:editorconfig buffer-local variable tofalse.false..editorconfig file, and (optionally) a table containing all of the otherproperties and their values (useful for properties which depend on otherproperties). The value is always a string and must be coerced if necessary.Example:require('editorconfig').properties.foo = function(bufnr, val, opts) if opts.charset and opts.charset ~= "utf-8" then error("foo can only be set when charset is utf-8", 0) end vim.b[bufnr].foo = valend"utf-8","utf-8-bom","latin1","utf-16be", or"utf-16le". Sets the'fileencoding' and'bomb' options."lf","crlf", or"cr". These correspond to setting'fileformat' to "unix", "dos", or "mac", respectively."true" or"false" to ensure the file always has a trailing newline as its last byte. Sets the'fixendofline' and'endofline' options..editorconfig files in parent directories. This property must be at the top-level of the.editorconfig file (i.e. it must not be within a glob section)."true", trailing whitespace is automatically removed when the buffer is written.stdpath('data') .. 'site/spell' or the first writable directory in the'runtimepath'.g:loaded_spellfile_plugin = 1.{url} (string) The base URL from where the spellfiles are downloaded. Usesg:spellfile_URL if it's set, otherwisehttps://ftp.nluug.nl/pub/vim/runtime/spell.{timeout_ms} (integer, default: 15000) Number of milliseconds after which thevim.net.request() times out.{opts})spellfile.config()require('nvim.spellfile').config({ url = '...' }){opts} (nvim.spellfile.Opts?) When omitted ornil, retrieve the current configuration. Otherwise, a configuration table.nvim.spellfile.Opts?) Current config if{opts} is omitted.{lang} (string) Language code.table?) A table with the following fields:{files} (string[]){key} (string){lang} (string){encoding} (string){dir} (string){file}:TOhtml{file}. If{file} is notgiven, a temporary file (created bytempname()) is used.{winid},{opt})tohtml.tohtml(){winid} to HTML and returns the output as a list of string.{winid} (integer?) Window to convert (defaults to current window){opt} (table?) Optional parameters.{title}? (string|false, default: buffer name) Title tag to set in the generated HTML code.{number_lines}? (boolean, default:false) Show line numbers.{font}? (string[]|string, default:guifont) Fonts to use.{width}? (integer, default:'textwidth' if non-zero or window width otherwise) Width used for items which are either right aligned or repeat a character infinitely.{range}? (integer[], default: entire buffer) Range of rows to use.string[])packadd nvim.undotree
{opts} (table?) A table with the following fields:{bufnr} (integer?) Buffer to draw the tree into. If omitted, a new buffer is created.{winid} (integer?) Window id to display the tree buffer in. If omitted, a new window is created with{command}.{command} (string?) Vimscript command to create the window. Default value is "30vnew". Only used when{winid} is nil.{title} ((string|fun(bufnr:integer):string?)?) Title of the window. If a function, it accepts the buffer number of the source buffer as its only argument and should return a string.boolean?) Returns true if the window was already open, nil otherwise