mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-11-10 12:35:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(pack): add plugin hooks example

Browse Source 
Problem: No examples of how to use `PackChanged[Pre]` for plugin hooks.

Solution: Add examples of creating plugin hooks.
This commit is contained in:
Evgeni Chasnovski
2025-10-23 20:26:54 +03:00
parent 16a6559ec6
commit 83f7d98518
2 changed files with 64 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
runtime/doc/pack.txt
View File

@@ -301,11 +301,37 @@ Available events to hook into ~
Each event populates the following |event-data| fields:
• `active` - whether plugin was added via |vim.pack.add()| to current session.
• `kind` - one of "install" (install on disk), "update" (update existing
plugin), "delete" (delete from disk).
• `kind` - one of "install" (install on disk; before loading), "update"
(update already installed plugin; might be not loaded), "delete" (delete
from disk).
• `spec` - plugin's specification with defaults made explicit.
• `path` - full path to plugin's directory.
These events can be used to execute plugin hooks. For example: >lua
local hooks = function(ev)
-- Use available |event-data|
local name, kind = ev.data.spec.name, ev.data.kind
-- Run build script after plugin's code has changed
if name == 'plug-1' and (kind == 'install' or kind == 'update') then
vim.system({ 'make' }, { cwd = ev.data.path })
end
-- If action relies on code from the plugin (like user command or
-- Lua code), make sure to explicitly load it first
if name == 'plug-2' and kind == 'update' then
if not ev.data.active then
vim.cmd.packadd('plug-2')
end
vim.cmd('PlugTwoUpdate')
require('plug2').after_update()
end
end
-- If hooks need to run on install, run this before `vim.pack.add()`
vim.api.nvim_create_autocmd('PackChanged', { callback = hooks })
<
*vim.pack.Spec*

31
runtime/lua/vim/pack.lua
View File

@@ -98,10 +98,37 @@
---
---Each event populates the following |event-data| fields:
---- `active` - whether plugin was added via |vim.pack.add()| to current session.
--- - `kind` - one of "install" (install on disk), "update" (update existing
--- plugin), "delete" (delete from disk).
---- `kind` - one of "install" (install on disk; before loading),
--- "update" (update already installed plugin; might be not loaded),
--- "delete" (delete from disk).
---- `spec` - plugin's specification with defaults made explicit.
---- `path` - full path to plugin's directory.
---
--- These events can be used to execute plugin hooks. For example:
---```lua
---local hooks = function(ev)
--- -- Use available |event-data|
--- local name, kind = ev.data.spec.name, ev.data.kind
---
--- -- Run build script after plugin's code has changed
--- if name == 'plug-1' and (kind == 'install' or kind == 'update') then
--- vim.system({ 'make' }, { cwd = ev.data.path })
--- end
---
--- -- If action relies on code from the plugin (like user command or
--- -- Lua code), make sure to explicitly load it first
--- if name == 'plug-2' and kind == 'update' then
--- if not ev.data.active then
--- vim.cmd.packadd('plug-2')
--- end
--- vim.cmd('PlugTwoUpdate')
--- require('plug2').after_update()
--- end
---end
---
----- If hooks need to run on install, run this before `vim.pack.add()`
---vim.api.nvim_create_autocmd('PackChanged', { callback = hooks })
---```
local api = vim.api
local uv = vim.uv