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