Skip to content

Commit b40ec94

Browse files
github-actions[bot]github-actions[bot]
committed
chore(build): auto-generate vimdoc
1 parent be3909c commit b40ec94

File tree

1 file changed

+56
-23
lines changed

1 file changed

+56
-23
lines changed

‎doc/lazy.nvim.txt

Lines changed: 56 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*lazy.nvim.txt* For Neovim >= 0.8.0 Last change: 2022 December 23
1+
*lazy.nvim.txt* For Neovim >= 0.8.0 Last change: 2022 December 24
22

33
==============================================================================
44
Table of Contents *lazy.nvim-table-of-contents*
@@ -110,28 +110,28 @@ It is recommended to run `:checkhealth lazy` after installation
110110

111111
PLUGIN SPEC *lazy.nvim-plugin-spec*
112112

113-
│ Property │ Type │ Description │
114-
│[1] │string? │Short plugin url. Will be expanded using config.git.url_format │
115-
│**dir** │string? │A directory pointing to a local plugin │
116-
│**url** │string? │A custom git url where the plugin is hosted │
117-
│**name** │string? │A custom name for the plugin used for the local plugin directory and as the display name │
118-
│**dev** │boolean? │When true, a local plugin directory will be used instead. See config.dev │
119-
│**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 │
120-
│**enabled** │boolean? or fun():boolean │When false, or if the function returns false, then this plugin will not be used │
121-
│**dependencies**│LazySpec[] │A list of plugin specs that should be loaded when the plugin loads. Dependencies are always lazy-loaded unless specified otherwise │
122-
│**init** │fun(LazyPlugin) │init functions are always executed during startup │
123-
│**config** │fun(LazyPlugin) or true or table │config is executed when the plugin loads. You can also set to true or pass a table, that will be passed to require("plugin").setup(opts) │
124-
│**build** │fun(LazyPlugin) or string │build is executed when a plugin is installed or updated. If it’s a string it will be ran as a shell command. When prefixed with : it is a Neovim command. │
125-
│**branch** │string? │Branch of the repository │
126-
│**tag** │string? │Tag of the repository │
127-
│**commit** │string? │Commit of the repository │
128-
│**version** │string? │Version to use from the repository. Full Semver <https://devhints.io/semver> ranges are supported │
129-
│**pin** │boolean? │When true, this plugin will not be included in updates │
130-
│**event** │string? or string[] │Lazy-load on event │
131-
│**cmd** │string? or string[] │Lazy-load on command │
132-
│**ft** │string? or string[] │Lazy-load on filetype │
133-
│**keys** │string? or string[] or LazyKeys[] │Lazy-load on key mapping │
134-
│**module** │false? │Do not automatically load this Lua module when it’s required somewhere │
113+
│ Property │ Type │ Description │
114+
│[1] │string? │Short plugin url. Will be expanded using config.git.url_format │
115+
│**dir** │string? │A directory pointing to a local plugin │
116+
│**url** │string? │A custom git url where the plugin is hosted │
117+
│**name** │string? │A custom name for the plugin used for the local plugin directory and as the display name │
118+
│**dev** │boolean? │When true, a local plugin directory will be used instead. See config.dev │
119+
│**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 │
120+
│**enabled** │boolean? or fun():boolean │When false, or if the function returns false, then this plugin will not be used │
121+
│**dependencies**│LazySpec[] │A list of plugin specs that should be loaded when the plugin loads. Dependencies are always lazy-loaded unless specified otherwise │
122+
│**init** │fun(LazyPlugin) │init functions are always executed during startup │
123+
│**config** │fun(LazyPlugin) or true or table │config is executed when the plugin loads. You can also set to true or pass a table, that will be passed to require("plugin").setup(opts) │
124+
│**build** │fun(LazyPlugin) or string or a list of build commands │build is executed when a plugin is installed or updated. 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 │
125+
│**branch** │string? │Branch of the repository │
126+
│**tag** │string? │Tag of the repository │
127+
│**commit** │string? │Commit of the repository │
128+
│**version** │string? │Version to use from the repository. Full Semver <https://devhints.io/semver> ranges are supported │
129+
│**pin** │boolean? │When true, this plugin will not be included in updates │
130+
│**event** │string? or string[] │Lazy-load on event │
131+
│**cmd** │string? or string[] │Lazy-load on command │
132+
│**ft** │string? or string[] │Lazy-load on filetype │
133+
│**keys** │string? or string[] or LazyKeys[] │Lazy-load on key mapping │
134+
│**module** │false? │Do not automatically load this Lua module when it’s required somewhere │
135135

136136

137137
LAZY LOADING ~
@@ -364,6 +364,39 @@ CONFIGURATION *lazy.nvim-configuration*
364364
task = " ",
365365
},
366366
throttle = 20, -- how frequently should the ui process render events
367+
custom_keys = {
368+
-- you can define custom key maps here.
369+
-- To disable one of the defaults, set it to false
370+
371+
-- open lazygit log
372+
["<localleader>l"] = function(plugin)
373+
require("lazy.util").open_cmd({ "lazygit", "log" }, {
374+
cwd = plugin.dir,
375+
terminal = true,
376+
close_on_exit = true,
377+
enter = true,
378+
})
379+
end,
380+
381+
-- open a terminal for the plugin dir
382+
["<localleader>t"] = function(plugin)
383+
require("lazy.util").open_cmd({ vim.go.shell }, {
384+
cwd = plugin.dir,
385+
terminal = true,
386+
close_on_exit = true,
387+
enter = true,
388+
})
389+
end,
390+
},
391+
},
392+
diff = {
393+
-- diff command <d> can be one of:
394+
-- browser: opens the github compare view. Note that this is always mapped to <K> as well,
395+
-- so you can have a different command for diff <d>
396+
-- git: will run git diff and open a buffer with filetype git
397+
-- terminal_git: will open a pseudo terminal with git diff
398+
-- diffview.nvim: will open Diffview to show the diff
399+
cmd = "git",
367400
},
368401
checker = {
369402
-- automatically check for plugin updates

0 commit comments

Comments
 (0)