mirror of https://github.com/folke/lazy.nvim.git
chore(build): auto-generate vimdoc
This commit is contained in:
github-actions[bot]
parent
a026f73953
commit
8a6379eddd
|
|
@ -103,113 +103,113 @@ 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
|
||||||
|
|
||||||
dir string? A directory pointing to a local plugin
|
dir string? A directory pointing to a local plugin
|
||||||
|
|
||||||
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
|
name string? A custom name for the plugin used for the local
|
||||||
plugin 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
|
lazy boolean? When true, the plugin will only be loaded when
|
||||||
needed. Lazy-loaded plugins are automatically loaded
|
needed. Lazy-loaded plugins are automatically loaded
|
||||||
when their Lua modules are required, or when one of
|
when their Lua modules are required, or when one of
|
||||||
the 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
|
this plugin will not be loaded. Useful to disable
|
||||||
some 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
|
dependencies LazySpec[] A list of plugin names or plugin specs that should
|
||||||
be loaded when the plugin loads. Dependencies are
|
be loaded when the plugin loads. Dependencies are
|
||||||
always lazy-loaded unless specified otherwise. When
|
always lazy-loaded unless specified otherwise. When
|
||||||
specifying a name, make sure the plugin spec has
|
specifying a name, make sure the plugin spec has
|
||||||
been 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
|
should change a table. The table will be passed to
|
||||||
the Plugin.config() function. Setting this value
|
the Plugin.config() function. Setting this value
|
||||||
will imply Plugin.config()
|
will imply Plugin.config()
|
||||||
|
|
||||||
config fun(LazyPlugin, opts:table) or true config is executed when the plugin loads. The
|
config fun(LazyPlugin, opts:table) or true config is executed when the plugin loads. The
|
||||||
default 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
|
||||||
opts. To use the default implementation without opts
|
opts. To use the default implementation without opts
|
||||||
set config to true.
|
set config to true.
|
||||||
|
|
||||||
main string? You can specify the main module to use for config()
|
main string? You can specify the main module to use for config()
|
||||||
and opts(), in case it can not be determined
|
and opts(), in case it can not be determined
|
||||||
automatically. See config()
|
automatically. See config()
|
||||||
|
|
||||||
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. When prefixed with : it is a Neovim
|
||||||
command. You can also specify a list to executed
|
command. You can also specify a list to executed
|
||||||
multiple build commands. Some plugins provide their
|
multiple build commands. Some plugins provide their
|
||||||
own build.lua which is automatically used by lazy.
|
own build.lua which is automatically used by lazy.
|
||||||
So no need to specify a build step for those
|
So no need to specify a build step for those
|
||||||
plugins.
|
plugins.
|
||||||
|
|
||||||
branch string? Branch of the repository
|
branch string? Branch of the repository
|
||||||
|
|
||||||
tag string? Tag of the repository
|
tag string? Tag of the repository
|
||||||
|
|
||||||
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
|
version string? or false to override the default Version to use from the repository. Full Semver
|
||||||
ranges are supported
|
ranges are supported
|
||||||
|
|
||||||
pin boolean? When true, this plugin will not be included in
|
pin boolean? When true, this plugin will not be included in
|
||||||
updates
|
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[] or 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}
|
{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[]
|
||||||
|
|
||||||
ft string? or string[] or Lazy-load on filetype
|
ft string? or string[] or Lazy-load on filetype
|
||||||
fun(self:LazyPlugin, ft:string[]):string[]
|
fun(self:LazyPlugin, ft:string[]):string[]
|
||||||
|
|
||||||
keys string? or string[] or LazyKeys[] or Lazy-load on key mapping
|
keys string? or string[] or LazyKeysSpec[] or Lazy-load on key mapping
|
||||||
fun(self:LazyPlugin, keys:string[]):(string \| LazyKeys)[]
|
fun(self:LazyPlugin, keys:string[]):(string \| LazyKeysSpec)[]
|
||||||
|
|
||||||
module false? Do not automatically load this Lua module when it’s
|
module false? Do not automatically load this Lua module when it’s
|
||||||
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
|
loading certain plugins first. Default priority is
|
||||||
50. It’s recommended to set this to a high number
|
50. It’s recommended to set this to a high number
|
||||||
for 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,
|
optional. This is mainly useful for Neovim distros,
|
||||||
to allow setting options on plugins that may/may not
|
to allow setting options on plugins that may/may not
|
||||||
be part of the user’s plugins
|
be part of the user’s plugins
|
||||||
--------------------------------------------------------------------------------------------------------------------------------
|
------------------------------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
LAZY LOADING ~
|
LAZY LOADING ~
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue