lazy.nvim/doc/lazy.nvim.txt

*lazy.nvim.txt*          For Neovim >= 0.8.0         Last change: 2023 July 22

==============================================================================
Table of Contents                                *lazy.nvim-table-of-contents*

1. lazy.nvim                                             |lazy.nvim-lazy.nvim|
  - Features                                    |lazy.nvim-lazy.nvim-features|
  - Requirements                            |lazy.nvim-lazy.nvim-requirements|
  - Installation                            |lazy.nvim-lazy.nvim-installation|
  - Plugin Spec                              |lazy.nvim-lazy.nvim-plugin-spec|
  - Configuration                          |lazy.nvim-lazy.nvim-configuration|
  - Usage                                          |lazy.nvim-lazy.nvim-usage|
  - Lockfile lazy-lock.json      |lazy.nvim-lazy.nvim-lockfile-lazy-lock.json|
  - Performance                              |lazy.nvim-lazy.nvim-performance|
  - Debug                                          |lazy.nvim-lazy.nvim-debug|
  - Startup Sequence                    |lazy.nvim-lazy.nvim-startup-sequence|
  - Structuring Your Plugins    |lazy.nvim-lazy.nvim-structuring-your-plugins|
  - 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|

==============================================================================
1. lazy.nvim                                             *lazy.nvim-lazy.nvim*

**lazy.nvim** is a modern plugin manager for Neovim.


FEATURES                                        *lazy.nvim-lazy.nvim-features*

- Manage all your Neovim plugins with a powerful UI
- Fast startup times thanks to automatic caching and bytecode compilation of Lua modules
- Partial clones instead of shallow clones
- Automatic lazy-loading of Lua modules and lazy-loading on events, commands, filetypes, and key mappings
- Automatically install missing plugins before starting up Neovim, allowing you to start using it right away
- Async execution for improved performance
- No need to manually compile plugins
- Correct sequencing of dependencies
- Configurable in multiple files
- Generates helptags of the headings in `README.md` files for plugins that don’t have vimdocs
- Dev options and patterns for using local plugins
- Profiling tools to optimize performance
- Lockfile `lazy-lock.json` to keep track of installed plugins
- Automatically check for updates
- Commit, branch, tag, version, and full Semver <https://devhints.io/semver> support
- Statusline component to see the number of pending updates
- Automatically lazy-loads colorschemes


REQUIREMENTS                                *lazy.nvim-lazy.nvim-requirements*

- Neovim >= **0.8.0** (needs to be built with **LuaJIT**)
- Git >= **2.19.0** (for partial clones support)
- a Nerd Font <https://www.nerdfonts.com/> **(optional)**


INSTALLATION                                *lazy.nvim-lazy.nvim-installation*

You can add the following Lua code to your `init.lua` to bootstrap
**lazy.nvim**

>lua
    local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
    if not vim.loop.fs_stat(lazypath) then
      vim.fn.system({
        "git",
        "clone",
        "--filter=blob:none",
        "https://github.com/folke/lazy.nvim.git",
        "--branch=stable", -- latest stable release
        lazypath,
      })
    end
    vim.opt.rtp:prepend(lazypath)
<

Nextstep is to add **lazy.nvim** below the code added in the prior step in
`init.lua`

>lua
    require("lazy").setup(plugins, opts)
<

- **plugins**this should be a `table` or a `string`
    - `table`a list with your |lazy.nvim-plugin-spec|
    - `string`a Lua module name that contains your |lazy.nvim-plugin-spec|. See |lazy.nvim-structuring-your-plugins|
- **opts**see |lazy.nvim-configuration| **(optional)**

>lua
    -- Example using a list of specs with the default options
    vim.g.mapleader = " " -- Make sure to set `mapleader` before lazy so your mappings are correct
    
    require("lazy").setup({
      "folke/which-key.nvim",
      { "folke/neoconf.nvim", cmd = "Neoconf" },
      "folke/neodev.nvim",
    })
<

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

  dir            string?                                                      A directory pointing to a local plugin

  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

  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

  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.

  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()

  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
                                                                              opts. To use the default implementation without opts
                                                                              set config to true.

  main           string?                                                      You can specify the main module to use for config()
                                                                              and opts(), in case it can not be determined
                                                                              automatically. See config()

  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.

  branch         string?                                                      Branch of the repository

  tag            string?                                                      Tag 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 ranges
                                                                              are supported

  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

  cmd            string? or string[] or                                       Lazy-load on command
                 fun(self:LazyPlugin, cmd:string[]):string[]                  

  ft             string? or string[] or                                       Lazy-load on filetype
                 fun(self:LazyPlugin, ft:string[]):string[]                   

  keys           string? or string[] or LazyKeys[] or                         Lazy-load on key mapping
                 fun(self:LazyPlugin, keys:string[]):(string \| LazyKeys)[]   

  module         false?                                                       Do not automatically load this Lua module when it’s
                                                                              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.

  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
  ----------------------------------------------------------------------------------------------------------------------------------

LAZY LOADING ~

**lazy.nvim** automagically lazy-loads Lua modules, so it is not needed to
specify `module=...` everywhere in your plugin specification. This means that
if you have a plugin `A` that is lazy-loaded and a plugin `B` that requires a
module of plugin `A`, then plugin `A` will be loaded on demand as expected.

If you don’t want this behavior for a certain plugin, you can specify that
with `module=false`. You can then manually load the plugin with `:Lazy load
foobar.nvim`.

You can configure **lazy.nvim** to lazy-load all plugins by default with
`config.defaults.lazy = true`.

Additionally, you can also lazy-load on **events**, **commands**, **file
types** and **key mappings**.

Plugins will be lazy-loaded when one of the following is `true`

- Theplugin only exists as a dependency in your spec
- It has an `event`, `cmd`, `ft` or `keys` key
- `config.defaults.lazy == true`


COLORSCHEMES

Colorscheme plugins can be configured with `lazy=true`. The plugin will
automagically load when doing `colorscheme foobar`.


  **NOTE:** since **start** plugins can possibly change existing highlight
  groups, it’s important to make sure that your main **colorscheme** is loaded
  first. To ensure this you can use the `priority=1000` field. **(see the
  examples)**

LAZY KEY MAPPINGS

The `keys` property can be a `string` or `string[]` for simple normal-mode
mappings, or it can be a `LazyKeys` table with the following key-value pairs:

- **[1]**(`string`) lhs **(required)**
- **[2]**(`string|fun()`) rhs **(optional)**
- **mode**(`string|string[]`) mode **(optional, defaults to "n")**
- any other option valid for `vim.keymap.set`

Key mappings will load the plugin the first time they get executed.

When `[2]` is `nil`, then the real mapping has to be created by the `config()`
function.

>lua
    -- Example for neo-tree.nvim
    {
      "nvim-neo-tree/neo-tree.nvim",
        keys = {
          { "<leader>ft", "<cmd>Neotree toggle<cr>", desc = "NeoTree" },
        },
        config = function()
          require("neo-tree").setup()
        end,
    }
<


VERSIONING ~

If you want to install a specific revision of a plugin, you can use `commit`,
`tag`, `branch`, `version`.

The `version` property supports Semver <https://semver.org/> ranges.

Click to see some examples ~

- latest stable version (this excludes pre-release versions)
- `1.2.x`any version that starts with `1.2`, such as `1.2.0`, `1.2.3`, etc.
- `^1.2.3`any version that is compatible with `1.2.3`, such as `1.3.0`, `1.4.5`, etc., but not `2.0.0`.
- `~1.2.3`any version that is compatible with `1.2.3`, such as `1.2.4`, `1.2.5`, but not `1.3.0`.
- `>1.2.3`any version that is greater than `1.2.3`, such as `1.3.0`, `1.4.5`, etc.
- `>=1.2.3`any version that is greater than or equal to `1.2.3`, such as `1.2.3`, `1.3.0`, `1.4.5`, etc.
- `<1.2.3`any version that is less than `1.2.3`, such as `1.1.0`, `1.0.5`, etc.
- `<=1.2.3`any version that is less than or equal to `1.2.3`, such as `1.2.3`, `1.1.0`, `1.0.5`, etc

You can set `config.defaults.version = ""` to install the latest stable version
of plugins that support Semver.


EXAMPLES ~

>lua
    return {
      -- the colorscheme should be available when starting Neovim
      {
        "folke/tokyonight.nvim",
        lazy = false, -- make sure we load this during startup if it is your main colorscheme
        priority = 1000, -- make sure to load this before all the other start plugins
        config = function()
          -- load the colorscheme here
          vim.cmd([[colorscheme tokyonight]])
        end,
      },
    
      -- I have a separate config.mappings file where I require which-key.
      -- With lazy the plugin will be automatically loaded when it is required somewhere
      { "folke/which-key.nvim", lazy = true },
    
      {
        "nvim-neorg/neorg",
        -- lazy-load on filetype
        ft = "norg",
        -- options for neorg. This will automatically call `require("neorg").setup(opts)`
        opts = {
          load = {
            ["core.defaults"] = {},
          },
        },
      },
    
      {
        "dstein64/vim-startuptime",
        -- lazy-load on a command
        cmd = "StartupTime",
        -- init is called during startup. Configuration for vim plugins typically should be set in an init function
        init = function()
          vim.g.startuptime_tries = 10
        end,
      },
    
      {
        "hrsh7th/nvim-cmp",
        -- load cmp on InsertEnter
        event = "InsertEnter",
        -- these dependencies will only be loaded when cmp loads
        -- dependencies are always lazy-loaded unless specified otherwise
        dependencies = {
          "hrsh7th/cmp-nvim-lsp",
          "hrsh7th/cmp-buffer",
        },
        config = function()
          -- ...
        end,
      },
    
      -- if some code requires a module from an unloaded plugin, it will be automatically loaded.
      -- So for api plugins like devicons, we can always set lazy=true
      { "nvim-tree/nvim-web-devicons", lazy = true },
    
      -- you can use the VeryLazy event for things that can
      -- load later and are not important for the initial UI
      { "stevearc/dressing.nvim", event = "VeryLazy" },
    
      {
        "Wansmer/treesj",
        keys = {
          { "J", "<cmd>TSJToggle<cr>", desc = "Join Toggle" },
        },
        opts = { use_default_keymaps = false, max_join_length = 150 },
      },
    
      {
        "monaqa/dial.nvim",
        -- lazy-load on keys
        -- mode is `n` by default. For more advanced options, check the section on key mappings
        keys = { "<C-a>", { "<C-x>", mode = "n" } },
      },
    
      -- local plugins need to be explicitly configured with dir
      { dir = "~/projects/secret.nvim" },
    
      -- you can use a custom url to fetch a plugin
      { url = "git@github.com:folke/noice.nvim.git" },
    
      -- local plugins can also be configure with the dev option.
      -- This will use {config.dev.path}/noice.nvim/ instead of fetching it from Github
      -- With the dev option, you can easily switch between the local and installed version of a plugin
      { "folke/noice.nvim", dev = true },
    }
<


CONFIGURATION                              *lazy.nvim-lazy.nvim-configuration*

**lazy.nvim** comes with the following defaults:

>lua
    {
      root = vim.fn.stdpath("data") .. "/lazy", -- directory where plugins will be installed
      defaults = {
        lazy = false, -- should plugins be lazy-loaded?
        version = nil,
        -- default `cond` you can use to globally disable a lot of plugins
        -- when running inside vscode for example
        cond = nil, ---@type boolean|fun(self:LazyPlugin):boolean|nil
        -- version = "", -- enable this to try installing the latest stable versions of plugins
      },
      -- leave nil when passing the spec as the first argument to setup()
      spec = nil, ---@type LazySpec
      lockfile = vim.fn.stdpath("config") .. "/lazy-lock.json", -- lockfile generated after running update.
      concurrency = jit.os:find("Windows") and (vim.loop.available_parallelism()  2) or nil, ---@type number limit the maximum amount of concurrent tasks
      git = {
        -- defaults for the `Lazy log` command
        -- log = { "-10" }, -- show the last 10 commits
        log = { "-8" }, -- show commits from the last 3 days
        timeout = 120, -- kill processes that take more than 2 minutes
        url_format = "https://github.com/%s.git",
        -- lazy.nvim requires git >=2.19.0. If you really want to use lazy with an older version,
        -- then set the below to false. This should work, but is NOT supported and will
        -- increase downloads a lot.
        filter = true,
      },
      dev = {
        -- directory where you store your local plugin projects
        path = "~/projects",
        ---@type string[] plugins that match these patterns will use your local versions instead of being fetched from GitHub
        patterns = {}, -- For example {"folke"}
        fallback = false, -- Fallback to git when local plugin doesn't exist
      },
      install = {
        -- install missing plugins on startup. This doesn't increase startup time.
        missing = true,
        -- try to load one of these colorschemes when starting an installation during startup
        colorscheme = { "habamax" },
      },
      ui = {
        -- a number <1 is a percentage., >1 is a fixed size
        size = { width = 0.8, height = 0.8 },
        wrap = true, -- wrap the lines in the ui
        -- The border to use for the UI window. Accepts same border values as |nvim_open_win()|.
        border = "none",
        title = nil, ---@type string only works when border is not "none"
        title_pos = "center", ---@type "center" | "left" | "right"
        -- Show pills on top of the Lazy window
        pills = true, ---@type boolean
        icons = {
          cmd = " ",
          config = "",
          event = "",
          ft = " ",
          init = " ",
          import = " ",
          keys = " ",
          lazy = "󰒲 ",
          loaded = "",
          not_loaded = "",
          plugin = " ",
          runtime = " ",
          source = " ",
          start = "",
          task = " ",
          list = {
            "",
            "",
            "",
            "‒",
          },
        },
        -- leave nil, to automatically select a browser depending on your OS.
        -- If you want to use a specific browser, you can define it here
        browser = nil, ---@type string?
        throttle = 20, -- how frequently should the ui process render events
        custom_keys = {
          -- you can define custom key maps here.
          -- To disable one of the defaults, set it to false
    
          -- open lazygit log
          ["<localleader>l"] = function(plugin)
            require("lazy.util").float_term({ "lazygit", "log" }, {
              cwd = plugin.dir,
            })
          end,
    
          -- open a terminal for the plugin dir
          ["<localleader>t"] = function(plugin)
            require("lazy.util").float_term(nil, {
              cwd = plugin.dir,
            })
          end,
        },
      },
      diff = {
        -- diff command <d> can be one of:
        --  browser: opens the github compare view. Note that this is always mapped to <K> as well,
        --   so you can have a different command for diff <d>
        --  git: will run git diff and open a buffer with filetype git
        --  terminal_git: will open a pseudo terminal with git diff
        --  diffview.nvim: will open Diffview to show the diff
        cmd = "git",
      },
      checker = {
        -- automatically check for plugin updates
        enabled = false,
        concurrency = nil, ---@type number? set to 1 to check for updates very slowly
        notify = true, -- get a notification when new updates are found
        frequency = 3600, -- check for updates every hour
      },
      change_detection = {
        -- automatically check for config file changes and reload the ui
        enabled = true,
        notify = true, -- get a notification when changes are found
      },
      performance = {
        cache = {
          enabled = true,
        },
        reset_packpath = true, -- reset the package path to improve startup time
        rtp = {
          reset = true, -- reset the runtime path to $VIMRUNTIME and your config directory
          ---@type string[]
          paths = {}, -- add any custom paths here that you want to includes in the rtp
          ---@type string[] list any plugins you want to disable here
          disabled_plugins = {
            -- "gzip",
            -- "matchit",
            -- "matchparen",
            -- "netrwPlugin",
            -- "tarPlugin",
            -- "tohtml",
            -- "tutor",
            -- "zipPlugin",
          },
        },
      },
      -- lazy can generate helptags from the headings in markdown readme files,
      -- so :help works even for plugins that don't have vim docs.
      -- when the readme opens with :help it will be correctly displayed as markdown
      readme = {
        enabled = true,
        root = vim.fn.stdpath("state") .. "/lazy/readme",
        files = { "README.md", "lua//README.md" },
        -- only generate markdown helptags for plugins that dont have docs
        skip_if_doc_exists = true,
      },
      state = vim.fn.stdpath("state") .. "/lazy/state.json", -- state info for checker and other things
      build = {
        -- Plugins can provide a `build.lua` file that will be executed when the plugin is installed
        -- or updated. When the plugin spec also has a `build` command, the plugin's `build.lua` not be
        -- executed. In this case, a warning message will be shown.
        warn_on_override = true,
      },
    }
<

If you don’t want to use a Nerd Font, you can replace the icons with Unicode symbols. ~

>lua
    {
      ui = {
        icons = {
          cmd = "⌘",
          config = "",
          event = "",
          ft = "",
          init = "",
          keys = "",
          plugin = "",
          runtime = "",
          source = "",
          start = "",
          task = "",
          lazy = " ",
        },
      },
    }
<


USAGE                                              *lazy.nvim-lazy.nvim-usage*

Plugins are managed with the `:Lazy` command. Open the help with `<?>` to see
all the key mappings.

You can press `<CR>` on a plugin to show its details. Most properties can be
hovered with `<K>` to open links, help files, readmes, git commits and git
issues.

Lazy can automatically check for updates in the background. This feature can be
enabled with `config.checker.enabled = true`.

Any operation can be started from the UI, with a sub command or an API
function:

  --------------------------------------------------------------------------------------------------------------
  Command                   Lua                              Description
  ------------------------- -------------------------------- ---------------------------------------------------
  :Lazy build {plugins}     require("lazy").build(opts)      Rebuild a plugin

  :Lazy check [plugins]     require("lazy").check(opts?)     Check for updates and show the log (git fetch)

  :Lazy clean [plugins]     require("lazy").clean(opts?)     Clean plugins that are no longer needed

  :Lazy clear               require("lazy").clear()          Clear finished tasks

  :Lazy debug               require("lazy").debug()          Show debug information

  :Lazy health              require("lazy").health()         Run :checkhealth lazy

  :Lazy help                require("lazy").help()           Toggle this help page

  :Lazy home                require("lazy").home()           Go back to plugin list

  :Lazy install [plugins]   require("lazy").install(opts?)   Install missing plugins

  :Lazy load {plugins}      require("lazy").load(opts)       Load a plugin that has not been loaded yet. Similar
                                                             to :packadd. Like :Lazy load foo.nvim. Use
                                                             :Lazy! load to skip cond checks.

  :Lazy log [plugins]       require("lazy").log(opts?)       Show recent updates

  :Lazy profile             require("lazy").profile()        Show detailed profiling

  :Lazy reload {plugins}    require("lazy").reload(opts)     Reload a plugin (experimental!!)

  :Lazy restore [plugins]   require("lazy").restore(opts?)   Updates all plugins to the state in the lockfile.
                                                             For a single 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 update

  :Lazy update [plugins]    require("lazy").update(opts?)    Update plugins. This will also update the lockfile
  --------------------------------------------------------------------------------------------------------------
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:

>shell
    $ nvim --headless "+Lazy! sync" +qa
<

`opts` is a table with the following key-values:

- **wait**when true, then the call will wait till the operation completed
- **show**when false, the UI will not be shown
- **plugins**a list of plugin names to run the operation on
- **concurrency**limit the `number` of concurrently running tasks

Stats API (`require("lazy").stats()`):

>lua
    {
      -- startuptime in milliseconds till UIEnter
      startuptime = 0,
      -- when true, startuptime is the accurate cputime for the Neovim process. (Linux & Macos)
      -- this is more accurate than `nvim --startuptime`, and as such will be slightly higher
      -- when false, startuptime is calculated based on a delta with a timestamp when lazy started.
      real_cputime = false,
      count = 0, -- total number of plugins
      loaded = 0, -- number of loaded plugins
      ---@type table<string, number>
      times = {},
    }
<

**lazy.nvim** provides a statusline component that you can use to show the
number of pending updates. Make sure to enable `config.checker.enabled = true`
to make this work.

Example of configuring lualine.nvim ~

>lua
    require("lualine").setup({
      sections = {
        lualine_x = {
          {
            require("lazy.status").updates,
            cond = require("lazy.status").has_updates,
            color = { fg = "ff9e64" },
          },
        },
      },
    })
<


USER EVENTS ~

The following user events will be triggered:

- **LazyDone**when lazy has finished starting up and loaded your config
- **LazySync**after running sync
- **LazyInstall**after an install
- **LazyUpdate**after an update
- **LazyClean**after a clean
- **LazyCheck**after checking for updates
- **LazyLog**after running log
- **LazyLoad**after loading a plugin. The `data` attribute will contain the plugin name.
- **LazySyncPre**before running sync
- **LazyInstallPre**before an install
- **LazyUpdatePre**before an update
- **LazyCleanPre**before a clean
- **LazyCheckPre**before checking for updates
- **LazyLogPre**before running log
- **LazyReload**triggered by change detection after reloading plugin specs
- **VeryLazy**triggered after `LazyDone` and processing `VimEnter` auto commands
- **LazyVimStarted**triggered after `UIEnter` when `require("lazy").stats().startuptime` has been calculated.
    Useful to update the startuptime on your dashboard.


LOCKFILE LAZY-LOCK.JSON          *lazy.nvim-lazy.nvim-lockfile-lazy-lock.json*

After every **update**, the local lockfile is updated with the installed
revisions. It is recommended to have this file under version control.

If you use your Neovim config on multiple machines, using the lockfile, you can
ensure that the same version of every plugin is installed.

If you are on another machine, you can do `:Lazy restore`, to update all your
plugins to the version from the lockfile.


PERFORMANCE                                  *lazy.nvim-lazy.nvim-performance*

Great care has been taken to make the startup code (`lazy.core`) as efficient
as possible. During startup, all Lua files used before `VimEnter` or
`BufReadPre` are byte-compiled and cached, similar to what impatient.nvim
<https://github.com/lewis6991/impatient.nvim> does.

My config for example loads in about `11ms` with `93` plugins. I do a lot of
lazy-loading though :)

**lazy.nvim** comes with an advanced profiler `:Lazy profile` to help you
improve performance. The profiling view shows you why and how long it took to
load your plugins.


DEBUG                                              *lazy.nvim-lazy.nvim-debug*

See an overview of active lazy-loading handlers and what’s in the module
cache.


STARTUP SEQUENCE                        *lazy.nvim-lazy.nvim-startup-sequence*

**lazy.nvim** does **NOT** use Neovim packages and even disables plugin loading
completely (`vim.go.loadplugins = false`). It takes over the complete startup
sequence for more flexibility and better performance.

In practice this means that step 10 of |Neovim Initialization| is done by Lazy:

1. All the plugins’ `init()` functions are executed
2. All plugins with `lazy=false` are loaded. This includes sourcing `/plugin` and `/ftdetect` files. (`/after` will not be sourced yet)
3. All files from `/plugin` and `/ftdetect` directories in you rtp are sourced (excluding `/after`)
4. All `/after/plugin` files are sourced (this includes `/after` from plugins)

Files from runtime directories are always sourced in alphabetical order.


STRUCTURING YOUR PLUGINS        *lazy.nvim-lazy.nvim-structuring-your-plugins*

Some users may want to split their plugin specs in multiple files. Instead of
passing a spec table to `setup()`, you can use a Lua module. The specs from the
**module** and any top-level **sub-modules** will be merged together in the
final spec, so it is not needed to add `require` calls in your main plugin file
to the other files.

The benefits of using this approach:

- Simple to **add** new plugin specs. Just create a new file in your plugins module.
- Allows for **caching** of all your plugin specs. This becomes important if you have a lot of smaller plugin specs.
- Spec changes will automatically be **reloaded** when they’re updated, so the `:Lazy` UI is always up to date.

Example:

- `~/.config/nvim/init.lua`

>lua
    require("lazy").setup("plugins")
<

- `~/.config/nvim/lua/plugins.lua` or `~/.config/nvim/lua/plugins/init.lua` **(this file is optional)**

>lua
    return {
      "folke/neodev.nvim",
      "folke/which-key.nvim",
      { "folke/neoconf.nvim", cmd = "Neoconf" },
    }
<

- Any lua file in `~/.config/nvim/lua/plugins/.lua` will be automatically merged in the main plugin spec

For a real-life example, you can check LazyVim
<https://github.com/LazyVim/LazyVim> and more specifically:

- lazyvim.plugins <https://github.com/LazyVim/LazyVim/tree/main/lua/lazyvim/plugins> contains all the plugin specs that will be loaded


IMPORTING SPECS, CONFIG & OPTS ~

As part of a spec, you can add `import` statements to import additional plugin
modules. Both of the `setup()` calls are equivalent:

>lua
    require("lazy").setup("plugins")
    
    -- Same as:
    require("lazy").setup({{import = "plugins"}})
<

To import multiple modules from a plugin, add additional specs for each import.
For example, to import LazyVim core plugins and an optional plugin:

>lua
    require("lazy").setup({
      spec = {
        { "LazyVim/LazyVim", import = "lazyvim.plugins" },
        { import = "lazyvim.plugins.extras.coding.copilot" },
      }
    )
<

When you import specs, you can override them by simply adding a spec for the
same plugin to your local specs, adding any keys you want to override / merge.

`opts`, `dependencies`, `cmd`, `event`, `ft` and `keys` are always merged with
the parent spec. Any other property will override the property from the parent
spec.


MIGRATION GUIDE                          *lazy.nvim-lazy.nvim-migration-guide*


PACKER.NVIM ~

- `setup` `init`
- `requires` `dependencies`
- `as` `name`
- `opt` `lazy`
- `run` `build`
- `lock` `pin`
- `disable=true` `enabled = false`
- `tag=''` `version=""`
- `after` **not needed** for most use-cases. Use `dependencies` otherwise.
- `wants` **not needed** for most use-cases. Use `dependencies` otherwise.
- `config` don’t support string type, use `fun(LazyPlugin)` instead.
- `module` is auto-loaded. No need to specify
- `keys` spec is |lazy.nvim-different|
- `rtp` can be accomplished with:

>lua
    config = function(plugin)
        vim.opt.rtp:append(plugin.dir .. "/custom-rtp")
    end
<

With packer `wants`, `requires` and `after` can be used to manage dependencies.
With lazy, this isn’t needed for most of the Lua dependencies. They can be
installed just like normal plugins (even with `lazy=true`) and will be loaded
when other plugins need them. The `dependencies` key can be used to group those
required plugins with the one that requires them. The plugins which are added
as `dependencies` will always be lazy-loaded and loaded when the plugin is
loaded.


PAQ-NVIM ~

- `as` `name`
- `opt` `lazy`
- `run` `build`


UNINSTALLING                                *lazy.nvim-lazy.nvim-uninstalling*

To uninstall **lazy.nvim**, you need to remove the following files and
directories:

- **data**`~/.local/share/nvim/lazy`
- **state**`~/.local/state/nvim/lazy`
- **lockfile**`~/.config/nvim/lazy-lock.json`


  Paths can differ if you changed `XDG` environment variables.

HIGHLIGHT GROUPS                        *lazy.nvim-lazy.nvim-highlight-groups*

Click to see all highlight groups ~

  ---------------------------------------------------------------------------------
  Highlight Group     Default Group            Description
  ------------------- ------------------------ ------------------------------------
  LazyButton          CursorLine               

  LazyButtonActive    Visual                   

  LazyComment         Comment                  

  LazyCommit          _@variable.builtin_      commitref

  LazyCommitIssue     Number                   

  LazyCommitScope     Italic                   conventional commit scope

  LazyCommitType      Title                    conventional commit type

  LazyDimmed          Conceal                  property

  LazyDir             _@text.reference_        directory

  LazyH1              IncSearch                homebutton

  LazyH2              Bold                     titles

  LazyLocal           Constant                 

  LazyNoCond          DiagnosticWarn           unloaded icon for a plugin where
                                               cond() was false

  LazyNormal          NormalFloat              

  LazyProgressDone    Constant                 progress bar done

  LazyProgressTodo    LineNr                   progress bar todo

  LazyProp            Conceal                  property

  LazyReasonCmd       Operator                 

  LazyReasonEvent     Constant                 

  LazyReasonFt        Character                

  LazyReasonImport    Identifier               

  LazyReasonKeys      Statement                

  LazyReasonPlugin    Special                  

  LazyReasonRuntime   _@macro_                 

  LazyReasonSource    Character                

  LazyReasonStart     _@field_                 

  LazySpecial         _@punctuation.special_   

  LazyTaskError       ErrorMsg                 taskerrors

  LazyTaskOutput      MsgArea                  task output

  LazyUrl             _@text.reference_        url

  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 <https://github.com/wbthomason/packer.nvim>
- paq-nvim <https://github.com/savq/paq-nvim>
- neopm <https://github.com/ii14/neopm>
- dep <https://github.com/chiyadev/dep>
- optpack.nvim <https://github.com/notomo/optpack.nvim>
- pact.nvim <https://github.com/rktjmp/pact.nvim>

==============================================================================
2. Links                                                     *lazy.nvim-links*

1. *image*: https://user-images.githubusercontent.com/292349/208301737-68fb279c-ba70-43ef-a369-8c3e8367d6b1.png
2. *image*: https://user-images.githubusercontent.com/292349/208301766-5c400561-83c3-4811-9667-1ec4bb3c43b8.png
3. *image*: https://user-images.githubusercontent.com/292349/208301790-7eedbfa5-d202-4e70-852e-de68aa47233b.png

Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

vim:tw=78:ts=8:noet:ft=help:norl: