okram78/vahti.nvim
github
5
0
0
0
vahti.nvim
vahti.nvim watches plugins managed by Neovim 0.12's built-in vim.pack.
It automatically checks for updates in the background and displays a
notification when they are available. You can also check manually with
:VahtiCheck. vahti.nvim never updates plugins automatically.
Read the full documentation.
Requirements
- Neovim 0.12 or newer
- Plugins installed with
vim.pack.add() - Git available on
PATH
If a plugin spec has a version, vahti treats it as a literal Git ref (for
example, a tag such as v1.2.3), not as a semver constraint.
Setup
Add vahti.nvim with vim.pack.add() and configure it in init.lua:
vim.pack.add({ "https://github.com/okram78/vahti.nvim" })
require("vahti").setup({
startup_delay = 3000,
check_interval = 24 * 60 * 60,
git_timeout = 10000,
})
By default, vahti waits three seconds after VimEnter and checks at most once
per day. Each Git check is terminated after 10 seconds by default. The last
successful check is stored in Neovim's state directory. A weekly check can be
configured like this:
require("vahti").setup({
check_interval = 7 * 24 * 60 * 60,
})
To check on every startup instead, set check_interval = 0:
require("vahti").setup({
startup_delay = 3000,
check_interval = 0,
})
When updates are found, vahti displays a notification with the plugin names.
Manual :VahtiCheck also reports when no plugin updates are available.
To review and apply updates, run Neovim's own mechanism:
:lua vim.pack.update()
This opens Neovim's review buffer. Use :write in that buffer to apply the
selected updates, or :quit to cancel them. The background check uses Git to
inspect remote revisions and does not modify plugin files.
To check immediately, run :VahtiCheck.
Tests
Run the local headless test suite from the repository root:
NVIM_APPNAME=vahti-test nvim --headless -u tests/minimal_init.lua -l tests/vahti_spec.lua
The tests mock Git and vim.pack, so they do not update installed plugins or
require a network connection.
Development
Run the tests locally:
NVIM_APPNAME=vahti-test nvim --headless -u tests/minimal_init.lua -l tests/vahti_spec.lua
Merging to main creates a version tag and GitHub release automatically.
Use +semver: minor or +semver: patch in a commit message when needed.