subcrip
/
lazy.nvim
mirror of https://github.com/folke/lazy.nvim.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore(build): auto-generate vimdoc

This commit is contained in:
github-actions[bot] 2023-10-11 12:26:07 +00:00
parent 99ee284739
commit 9ca9a63be5
1 changed files with 40 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
doc/lazy.nvim.txt
View File

@ -1,4 +1,4 @@
*lazy.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 October 10 *lazy.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 October 11
============================================================================== ==============================================================================
Table of Contents *lazy.nvim-table-of-contents* Table of Contents *lazy.nvim-table-of-contents*
@ -103,9 +103,9 @@ It is recommended to run `:checkhealth lazy` after installation.
PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec* PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec*
---------------------------------------------------------------------------------------------------------------------------------- --------------------------------------------------------------------------------------------------------------------------------
Property Type Description Property Type Description
-------------- ------------------------------------------------------------ ------------------------------------------------------ -------------- ------------------------------------------------------------ ----------------------------------------------------
[1] string? Short plugin url. Will be expanded using [1] string? Short plugin url. Will be expanded using
config.git.url_format config.git.url_format
@ -113,40 +113,40 @@ PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec*
url string? A custom git url where the plugin is hosted url string? A custom git url where the plugin is hosted
name string? A custom name for the plugin used for the local plugin name string? A custom name for the plugin used for the local
directory and as the display name plugin directory and as the display name
dev boolean? When true, a local plugin directory will be used dev boolean? When true, a local plugin directory will be used
instead. See config.dev instead. See config.dev
lazy boolean? When true, the plugin will only be loaded when needed. lazy boolean? When true, the plugin will only be loaded when
Lazy-loaded plugins are automatically loaded when needed. Lazy-loaded plugins are automatically loaded
their Lua modules are required, or when one of the when their Lua modules are required, or when one of
lazy-loading handlers triggers the lazy-loading handlers triggers
enabled boolean? or fun():boolean When false, or if the function returns false, then enabled boolean? or fun():boolean When false, or if the function returns false, then
this plugin will not be included in the spec this plugin will not be included in the spec
cond boolean? or fun(LazyPlugin):boolean When false, or if the function returns false, then cond boolean? or fun(LazyPlugin):boolean When false, or if the function returns false, then
this plugin will not be loaded. Useful to disable some this plugin will not be loaded. Useful to disable
plugins in vscode, or firenvim for example. some plugins in vscode, or firenvim for example.
dependencies LazySpec[] A list of plugin names or plugin specs that should be dependencies LazySpec[] A list of plugin names or plugin specs that should
loaded when the plugin loads. Dependencies are always be loaded when the plugin loads. Dependencies are
lazy-loaded unless specified otherwise. When always lazy-loaded unless specified otherwise. When
specifying a name, make sure the plugin spec has been specifying a name, make sure the plugin spec has
defined somewhere else. been defined somewhere else.
init fun(LazyPlugin) init functions are always executed during startup init fun(LazyPlugin) init functions are always executed during startup
opts table or fun(LazyPlugin, opts:table) opts should be a table (will be merged with parent opts table or fun(LazyPlugin, opts:table) opts should be a table (will be merged with parent
specs), return a table (replaces parent specs) or specs), return a table (replaces parent specs) or
should change a table. The table will be passed to the should change a table. The table will be passed to
Plugin.config() function. Setting this value will the Plugin.config() function. Setting this value
imply Plugin.config() will imply Plugin.config()
config fun(LazyPlugin, opts:table) or true config is executed when the plugin loads. The default config fun(LazyPlugin, opts:table) or true config is executed when the plugin loads. The
implementation will automatically run default implementation will automatically run
require(MAIN).setup(opts). Lazy uses several require(MAIN).setup(opts). Lazy uses several
heuristics to determine the plugin’s MAIN module heuristics to determine the plugin’s MAIN module
automatically based on the plugin’s name. See also automatically based on the plugin’s name. See also
@ -160,11 +160,12 @@ PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec*
build fun(LazyPlugin) or string or a list of build commands build is executed when a plugin is installed or build fun(LazyPlugin) or string or a list of build commands build is executed when a plugin is installed or
updated. Before running build, a plugin is first updated. Before running build, a plugin is first
loaded. If it’s a string it will be ran as a shell loaded. If it’s a string it will be ran as a shell
command. When prefixed with : it is a Neovim command. command. When prefixed with : it is a Neovim
You can also specify a list to executed multiple build command. You can also specify a list to executed
commands. Some plugins provide their own build.lua multiple build commands. Some plugins provide their
which is automatically used by lazy. So no need to own build.lua which is automatically used by lazy.
specify a build step for those plugins. So no need to specify a build step for those
plugins.
branch string? Branch of the repository branch string? Branch of the repository
@ -172,16 +173,18 @@ PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec*
commit string? Commit of the repository commit string? Commit of the repository
version string? or false to override the default Version to use from the repository. Full Semver ranges version string? or false to override the default Version to use from the repository. Full Semver
are supported ranges are supported
pin boolean? When true, this plugin will not be included in updates pin boolean? When true, this plugin will not be included in
updates
submodules boolean? When false, git submodules will not be fetched. submodules boolean? When false, git submodules will not be fetched.
Defaults to true Defaults to true
event string? or string[] or Lazy-load on event. Events can be specified as event string? or string[] or Lazy-load on event. Events can be specified as
fun(self:LazyPlugin, event:string[]):string[] BufEnter or with a pattern like BufEnter *.lua fun(self:LazyPlugin, event:string[]):string[] or BufEnter or with a pattern like BufEnter *.lua
{event:string[]\|string, pattern?:string[]\|string}
cmd string? or string[] or Lazy-load on command cmd string? or string[] or Lazy-load on command
fun(self:LazyPlugin, cmd:string[]):string[] fun(self:LazyPlugin, cmd:string[]):string[]
@ -196,17 +199,17 @@ PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec*
required somewhere required somewhere
priority number? Only useful for start plugins (lazy=false) to force priority number? Only useful for start plugins (lazy=false) to force
loading certain plugins first. Default priority is 50. loading certain plugins first. Default priority is
It’s recommended to set this to a high number for 50. It’s recommended to set this to a high number
colorschemes. for colorschemes.
optional boolean? When a spec is tagged optional, it will only be optional boolean? When a spec is tagged optional, it will only be
included in the final spec, when the same plugin has included in the final spec, when the same plugin has
been specified at least once somewhere else without been specified at least once somewhere else without
optional. This is mainly useful for Neovim distros, to optional. This is mainly useful for Neovim distros,
allow setting options on plugins that may/may not be to allow setting options on plugins that may/may not
part of the user’s plugins be part of the user’s plugins
---------------------------------------------------------------------------------------------------------------------------------- --------------------------------------------------------------------------------------------------------------------------------
LAZY LOADING ~ LAZY LOADING ~