(mini.deps) Update hooks to be called with table data argument.

Author: echasnovski

doc/mini-deps.txt

@@ -277,11 +277,16 @@ Primarily, specification is a table with the following fields:
   Default: `nil` for no dependencies.
 
 - <hooks> `(table|nil)` - table with callable hooks to call on certain events.
-  Each hook is executed without arguments. Possible hook names:
+  Possible hook names:
     - <pre_install>   - before creating plugin directory.
     - <post_install>  - after  creating plugin directory.
     - <pre_checkout>  - before making change in plugin directory.
     - <post_checkout> - after  making change in plugin directory.
+  Each hook is executed with the following table as an argument:
+    - <path> (`string`)   - absolute path to plugin's directory
+      (might not yet exist on disk).
+    - <source> (`string`) - resolved <source> from spec.
+    - <name> (`string`)   - resolved <name> from spec.
   Default: `nil` for no hooks.
 
 ------------------------------------------------------------------------------

lua/mini/deps.lua

@@ -274,11 +274,16 @@
 ---   Default: `nil` for no dependencies.
 ---
 --- - <hooks> `(table|nil)` - table with callable hooks to call on certain events.
----   Each hook is executed without arguments. Possible hook names:
+---   Possible hook names:
 ---     - <pre_install>   - before creating plugin directory.
 ---     - <post_install>  - after  creating plugin directory.
 ---     - <pre_checkout>  - before making change in plugin directory.
 ---     - <post_checkout> - after  making change in plugin directory.
+---   Each hook is executed with the following table as an argument:
+---     - <path> (`string`)   - absolute path to plugin's directory
+---       (might not yet exist on disk).
+---     - <source> (`string`) - resolved <source> from spec.
+---     - <name> (`string`)   - resolved <name> from spec.
 ---   Default: `nil` for no hooks.
 ---@tag MiniDeps-plugin-specification
 
@@ -1001,7 +1006,7 @@ H.plugs_exec_hooks = function(plugs, name)
     local has_error = p.job and #p.job.err > 0
     local should_execute = vim.is_callable(p.hooks[name]) and not has_error
     if should_execute then
-      local ok, err = pcall(p.hooks[name])
+      local ok, err = pcall(p.hooks[name], { path = p.path, source = p.source, name = p.name })
       if not ok then
         local msg = string.format('Error executing %s hook in `%s`:\n%s', name, p.name, err)
         H.notify(msg, 'ERROR')

tests/test_deps.lua

@@ -847,25 +847,55 @@ T['add()']['Install']['properly executes `*_install` hooks'] = function()
     _G.process_mock_data = { [2] = { duration = 10 }, [3] = { duration = 5 } }
 
     -- Add plugin with dependency and hooks
+    _G.args = {}
+    local make_hook = function(msg)
+      return function(...)
+        table.insert(_G.args, { msg, { ... } })
+        vim.notify(msg)
+      end
+    end
+
     local dep_spec = {
       source = 'user/dep_plugin',
       hooks = {
-        pre_install = function() vim.notify('Dependency pre_install') end,
-        post_install = function() vim.notify('Dependency post_install') end,
+        pre_install = make_hook('Dependency pre_install'),
+        post_install = make_hook('Dependency post_install'),
       },
     }
     local spec = {
       source = 'user/new_plugin',
       depends = { dep_spec },
       hooks = {
-        pre_install = function() vim.notify('Target pre_install') end,
-        post_install = function() vim.notify('Target post_install') end,
+        pre_install = make_hook('Target pre_install'),
+        post_install = make_hook('Target post_install'),
       },
     }
 
     MiniDeps.add(spec)
   ]])
 
+  -- Should be called with proper arguments
+  local cwd_new_plugin, cwd_dep_plugin = test_opt_dir .. '/new_plugin', test_opt_dir .. '/dep_plugin'
+  local ref_args = {
+    {
+      'Dependency pre_install',
+      { { path = cwd_dep_plugin, source = 'https://github.com/user/dep_plugin', name = 'dep_plugin' } },
+    },
+    {
+      'Target pre_install',
+      { { path = cwd_new_plugin, source = 'https://github.com/user/new_plugin', name = 'new_plugin' } },
+    },
+    {
+      'Dependency post_install',
+      { { path = cwd_dep_plugin, source = 'https://github.com/user/dep_plugin', name = 'dep_plugin' } },
+    },
+    {
+      'Target post_install',
+      { { path = cwd_new_plugin, source = 'https://github.com/user/new_plugin', name = 'new_plugin' } },
+    },
+  }
+  eq(child.lua_get('_G.args'), ref_args)
+
   -- Should produce notifications
   local ref_notify_log = {
     -- Hooks are executed in a session order
@@ -1378,14 +1408,22 @@ end
 
 T['update()']['properly executes `*_checkout` hooks'] = function()
   child.lua([[
-    -- Add plugin with dependency and hooks
+    -- Add plugins with hooks
+    _G.args = {}
+    local make_hook = function(msg)
+      return function(...)
+        table.insert(_G.args, { msg, { ... } })
+        vim.notify(msg)
+      end
+    end
+
     for i = 1, 3 do
       local name = 'plugin_' .. i
       MiniDeps.add({
         source = 'user/' .. name,
         hooks = {
-          pre_checkout = function() vim.notify(name .. ' pre_checkout') end,
-          post_checkout = function() vim.notify(name .. ' post_checkout') end,
+          pre_checkout = make_hook(name .. ' pre_checkout'),
+          post_checkout = make_hook(name .. ' post_checkout'),
         },
       })
     end
@@ -1420,6 +1458,28 @@ T['update()']['properly executes `*_checkout` hooks'] = function()
   ]])
   child.lua('MiniDeps.update(nil, { force = true })')
 
+  -- Should be called with proper arguments
+  local cwd_plugin_1, cwd_plugin_2 = test_opt_dir .. '/plugin_1', test_opt_dir .. '/plugin_2'
+  local ref_args = {
+    {
+      'plugin_1 pre_checkout',
+      { { path = cwd_plugin_1, source = 'https://github.com/user/plugin_1', name = 'plugin_1' } },
+    },
+    {
+      'plugin_2 pre_checkout',
+      { { path = cwd_plugin_2, source = 'https://github.com/user/plugin_2', name = 'plugin_2' } },
+    },
+    {
+      'plugin_1 post_checkout',
+      { { path = cwd_plugin_1, source = 'https://github.com/user/plugin_1', name = 'plugin_1' } },
+    },
+    {
+      'plugin_2 post_checkout',
+      { { path = cwd_plugin_2, source = 'https://github.com/user/plugin_2', name = 'plugin_2' } },
+    },
+  }
+  eq(child.lua_get('_G.args'), ref_args)
+
   -- Should produce notifications
   local ref_notify_log = {
     { '(mini.deps) Downloading 3 updates', 'INFO' },