Directory structure

This module uses built-in packages to make plugins usable in current session. It works with “pack/deps” package insideconfig.path.package directory.

By default “opt” subdirectory is used to install optional plugins which are loaded on demand withMiniDeps.add(). Non-optional plugins in “start” subdirectory are supported but only if moved there manually after initial install.

Add plugin

UseMiniDeps.add() to add plugin to current session. Supply plugin’s URL source as a string or plugin specification in general. If plugin is not present in “pack/deps” package, it will be created (a.k.a. installed) before processing anything else.

The recommended way of adding a plugin is by callingMiniDeps.add() in the ‘init.lua’ file (make sureMiniDeps.setup() is called prior):

localadd=MiniDeps.add-- Add to current session (install if absent)add({source='neovim/nvim-lspconfig',-- Supply dependencies near target plugindepends={'williamboman/mason.nvim'},})add({source='nvim-treesitter/nvim-treesitter',-- Use 'master' while monitoring updates in 'main'checkout='master',monitor='main',-- Perform action after every checkouthooks={post_checkout=function()vim.cmd('TSUpdate')end},})-- Possible to immediately execute code which depends on the added pluginrequire('nvim-treesitter.configs').setup({ensure_installed={'lua','vimdoc'},highlight={enable=true},})

NOTE:

• To increase performance,add() only ensures presence on disk and nothing else. In particular, it doesn’t ensureopts.checkout state. Update or modify plugin state explicitly (see later sections).

Plugin specification

Specification can be a single string which is inferred as:

• Pluginname if it doesn’t contain “/”.
• Pluginsource otherwise.

Primarily, specification is a table with the following fields (see:h MiniDeps-plugin-specification for more details):

Lazy loading

Any lazy-loading is assumed to be done manually by callingMiniDeps.add() at appropriate time. This module provides helpers implementing special safe two-stage loading:

• MiniDeps.now() safely executes code immediately. Use it to load plugins with UI necessary to make initial screen draw.
• MiniDeps.later() schedules code to be safely executed later, preserving order. Use it (with caution) for everything else which doesn’t need precisely timed effect, as it will be executed some time soon on one of the next event loops.

localnow,later=MiniDeps.now,MiniDeps.later-- Safely execute immediatelynow(function()vim.cmd('colorscheme miniwinter')end)now(function()require('mini.statusline').setup()end)-- Safely execute laterlater(function()require('mini.pick').setup()end)

Update

To update plugins from current session with new data from their sources, use:DepsUpdate. This will download updates (utilizing multiple cores) and show confirmation buffer. Follow instructions at its top to finish an update.

NOTE: This updates plugins on disk which most likely won’t affect current session. Restart Nvim to have them properly loaded.

Modify

To change plugin’s specification (like set differentcheckout, etc.):

• Update correspondingMiniDeps.add() call.
• Run:DepsUpdateOffline <plugin_name>.
• Review changes and confirm.
• Restart Nvim.

NOTE: ifadd() prior used a single source string, make sure to convert its argument to{ source = '<previous_argument>', checkout = '<state>'}

Snapshots

Use:DepsSnapSave to save state of all plugins from current session into a snapshot file (seeconfig.path.snapshot).

Use:DepsSnapLoad to load snapshot. This will change (without confirmation) state on disk. Plugins present in both snapshot file and current session will be affected. Restart Nvim to see the effect.

NOTE: loading snapshot does not change plugin’s specification defined insideMiniDeps.add() call. This means that next update might change plugin’s state. To make it permanent, freeze plugin in target state manually.

Freeze

Modify plugin’s specification to havecheckout pointing to a static target: tag, state (commit hash), or ‘HEAD’ (to freeze in current state).

Frozen plugins will not receive updates. You can monitor any new changes from its source by “subscribing” tomonitor branch which will be shown inside confirmation buffer after:DepsUpdate.

Example: usecheckout = 'v0.10.0' to freeze plugin at tag “v0.10.0” while monitoring new versions in the log frommonitor (usually default) branch.

Rollback

To roll back after an unfortunate update:

• Get identifier of latest working state:
  • Use:DepsShowLog to see update log, look for plugin’s name, and copy identifier listed as “State before:”.
  • See previously saved snapshot file for plugin’s name and copy identifier next to it.
• Freeze plugin at that state while monitoring appropriate branch. Revert to previous shape ofMiniDeps.add() call to resume updating.

Remove

• Make sure that target plugin is not registered in current session. Usually it means removing correspondingMiniDeps.add() call.
• Run:DepsClean. This will show confirmation buffer with a list of plugins to be deleted from disk. Follow instructions at its top to finish cleaning.

Alternatively, manually delete plugin’s directory from “pack/deps” package.