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] 2024-05-26 14:44:42 +00:00
parent 9dde1f1bce
commit a55d275eca
1 changed files with 52 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

121
doc/lazy.nvim.txt
View File

@ -411,6 +411,7 @@ CONFIGURATION *lazy.nvim-lazy.nvim-configuration*
}, },
-- leave nil when passing the spec as the first argument to setup() -- leave nil when passing the spec as the first argument to setup()
spec = nil, ---@type LazySpec spec = nil, ---@type LazySpec
local_spec = true, -- load project specific .lazy.lua spec files. They will be added at the end of the spec.
lockfile = vim.fn.stdpath("config") .. "/lazy-lock.json", -- lockfile generated after running update. lockfile = vim.fn.stdpath("config") .. "/lazy-lock.json", -- lockfile generated after running update.
---@type number? limit the maximum amount of concurrent tasks ---@type number? limit the maximum amount of concurrent tasks
concurrency = jit.os:find("Windows") and (vim.uv.available_parallelism() * 2) or nil, concurrency = jit.os:find("Windows") and (vim.uv.available_parallelism() * 2) or nil,
@ -615,17 +616,14 @@ enabled with `config.checker.enabled = true`.
Any operation can be started from the UI, with a sub command or an API Any operation can be started from the UI, with a sub command or an API
function: function:
---------------------------------------------------------------------------------- --------------------------------------------------------------------------------------------------------------
Command Lua Description Command Lua Description
------------------------- -------------------------------- ----------------------- ------------------------- -------------------------------- ---------------------------------------------------
:Lazy build {plugins} require("lazy").build(opts) Rebuild a plugin :Lazy build {plugins} require("lazy").build(opts) Rebuild a plugin
:Lazy check [plugins] require("lazy").check(opts?) Check for updates and :Lazy check [plugins] require("lazy").check(opts?) Check for updates and show the log (git fetch)
show the log (git
fetch)
:Lazy clean [plugins] require("lazy").clean(opts?) Clean plugins that are :Lazy clean [plugins] require("lazy").clean(opts?) Clean plugins that are no longer needed
no longer needed
:Lazy clear require("lazy").clear() Clear finished tasks :Lazy clear require("lazy").clear() Clear finished tasks
@ -639,36 +637,24 @@ function:
:Lazy install [plugins] require("lazy").install(opts?) Install missing plugins :Lazy install [plugins] require("lazy").install(opts?) Install missing plugins
:Lazy load {plugins} require("lazy").load(opts) Load a plugin that has :Lazy load {plugins} require("lazy").load(opts) Load a plugin that has not been loaded yet. Similar
not been loaded yet. to :packadd. Like :Lazy load foo.nvim. Use
Similar to :packadd. :Lazy! load to skip cond checks.
Like
:Lazy load foo.nvim.
Use :Lazy! load to skip
cond checks.
:Lazy log [plugins] require("lazy").log(opts?) Show recent updates :Lazy log [plugins] require("lazy").log(opts?) Show recent updates
:Lazy profile require("lazy").profile() Show detailed profiling :Lazy profile require("lazy").profile() Show detailed profiling
:Lazy reload {plugins} require("lazy").reload(opts) Reload a plugin :Lazy reload {plugins} require("lazy").reload(opts) Reload a plugin (experimental!!)
(experimental!!)
:Lazy restore [plugins] require("lazy").restore(opts?) Updates all plugins to :Lazy restore [plugins] require("lazy").restore(opts?) Updates all plugins to the state in the lockfile.
the state in the For a single plugin: restore it to the state in the
lockfile. For a single lockfile or to a given commit under the cursor
plugin: restore it to
the state in the
lockfile or to a given
commit under the cursor
:Lazy sync [plugins] require("lazy").sync(opts?) Run install, clean and :Lazy sync [plugins] require("lazy").sync(opts?) Run install, clean and update
update
:Lazy update [plugins] require("lazy").update(opts?) Update plugins. This :Lazy update [plugins] require("lazy").update(opts?) Update plugins. This will also update the lockfile
will also update the --------------------------------------------------------------------------------------------------------------
lockfile
----------------------------------------------------------------------------------
Any command can have a **bang** to make the command wait till it finished. For Any command can have a **bang** to make the command wait till it finished. For
example, if you want to sync lazy from the cmdline, you can use: example, if you want to sync lazy from the cmdline, you can use:
@ -924,77 +910,74 @@ HIGHLIGHT GROUPS *lazy.nvim-lazy.nvim-highlight-groups*
Click to see all highlight groups ~ Click to see all highlight groups ~
----------------------------------------------------------------------- ---------------------------------------------------------------------------------
Highlight Group Default Group Description Highlight Group Default Group Description
----------------------- ----------------------- ----------------------- ------------------- ------------------------ ------------------------------------
LazyButton CursorLine LazyButton CursorLine
LazyButtonActive Visual LazyButtonActive Visual
LazyComment Comment LazyComment Comment
LazyCommit @variable.builtin commit ref LazyCommit _@variable.builtin_ commitref
LazyCommitIssue Number LazyCommitIssue Number
LazyCommitScope Italic conventional commit LazyCommitScope Italic conventional commit scope
scope
LazyCommitType Title conventional commit LazyCommitType Title conventional commit type
type
LazyDimmed Conceal property LazyDimmed Conceal property
LazyDir @markup.link directory LazyDir _@markup.link_ directory
LazyH1 IncSearch home button LazyH1 IncSearch homebutton
LazyH2 Bold titles LazyH2 Bold titles
LazyLocal Constant LazyLocal Constant
LazyNoCond DiagnosticWarn unloaded icon for a LazyNoCond DiagnosticWarn unloaded icon for a plugin where
plugin where cond() was cond() was false
false
LazyNormal NormalFloat LazyNormal NormalFloat
LazyProgressDone Constant progress bar done LazyProgressDone Constant progress bar done
LazyProgressTodo LineNr progress bar todo LazyProgressTodo LineNr progress bar todo
LazyProp Conceal property LazyProp Conceal property
LazyReasonCmd Operator LazyReasonCmd Operator
LazyReasonEvent Constant LazyReasonEvent Constant
LazyReasonFt Character LazyReasonFt Character
LazyReasonImport Identifier LazyReasonImport Identifier
LazyReasonKeys Statement LazyReasonKeys Statement
LazyReasonPlugin Special LazyReasonPlugin Special
LazyReasonRequire @variable.parameter LazyReasonRequire _@variable.parameter_
LazyReasonRuntime @macro LazyReasonRuntime _@macro_
LazyReasonSource Character LazyReasonSource Character
LazyReasonStart @variable.member LazyReasonStart _@variable.member_
LazySpecial @punctuation.special LazySpecial _@punctuation.special_
LazyTaskError ErrorMsg task errors LazyTaskError ErrorMsg taskerrors
LazyTaskOutput MsgArea task output LazyTaskOutput MsgArea task output
LazyUrl @markup.link url LazyUrl _@markup.link_ url
LazyValue @string value of a property LazyValue _@string_ valueof a property
----------------------------------------------------------------------- ---------------------------------------------------------------------------------
PLUGIN AUTHORS *lazy.nvim-lazy.nvim-plugin-authors* PLUGIN AUTHORS *lazy.nvim-lazy.nvim-plugin-authors*