From d54ae0b96d60ff07f5774a431406b33a17491794 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 30 Jun 2023 16:29:13 +0000 Subject: [PATCH] chore(build): auto-generate vimdoc --- doc/lazy.nvim.txt | 78 +++++++++++++++++++++++++++-------------------- 1 file changed, 45 insertions(+), 33 deletions(-) diff --git a/doc/lazy.nvim.txt b/doc/lazy.nvim.txt index ba139a6..51c9d09 100644 --- a/doc/lazy.nvim.txt +++ b/doc/lazy.nvim.txt @@ -18,6 +18,7 @@ Table of Contents *lazy.nvim-table-of-contents* - Migration Guide |lazy.nvim-lazy.nvim-migration-guide| - Uninstalling |lazy.nvim-lazy.nvim-uninstalling| - Highlight Groups |lazy.nvim-lazy.nvim-highlight-groups| + - Plugin Authors |lazy.nvim-lazy.nvim-plugin-authors| - Other Neovim Plugin Managers in Lua|lazy.nvim-lazy.nvim-other-neovim-plugin-managers-in-lua| ============================================================================== @@ -102,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 @@ -112,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,8 +161,10 @@ PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec* 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 + 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 @@ -169,11 +172,10 @@ 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 @@ -194,17 +196,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 ~ @@ -936,6 +938,16 @@ Click to see all highlight groups ~ LazyValue _@string_ valueof a property --------------------------------------------------------------------------------- +PLUGIN AUTHORS *lazy.nvim-lazy.nvim-plugin-authors* + +If your plugin needs a build step, you can create a file `build.lua` or +`build/init.lua` in the root of your repo. This file will be loaded when the +plugin is installed or updated. + +This makes it easier for users, so they no longer need to specify a `build` +command. + + OTHER NEOVIM PLUGIN MANAGERS IN LUA*lazy.nvim-lazy.nvim-other-neovim-plugin-managers-in-lua* - packer.nvim