fix(pack)!: adjust install confirm (no error on "No", show names)

Problem: Installation confirmation has several usability issues:
    - Choosing "No" results in a `vim.pack.add()` error. This was by
      design to ensure that all later code that *might* reference
      presumably installed plugin will not get executed. However, this
      is often too restrictive since there might be no such code (like
      if plugin's effects are automated in its 'plugin/' directory).
      Instead the potential code using not installed plugin will throw
      an error.

      No error on "No" will also be useful for planned lockfile repair.

    - List of soon-to-be-installed plugins doesn't mention plugin names.
      This might be confusing if plugins are installed under different
      name.

Solution: Silently drop installation step if user chose "No" and show
  plugin names in confirmation text (together with their pretty aligned
  sources).
This commit is contained in:
Evgeni Chasnovski
2025-11-13 15:45:48 +02:00
parent 5d258854a7
commit 9e2599df05
2 changed files with 39 additions and 29 deletions

View File

@@ -545,16 +545,24 @@ local function confirm_install(plug_list)
return true return true
end end
local src = {} --- @type string[] -- Gather pretty aligned list of plugins to install
for _, p in ipairs(plug_list) do local name_width, name_max_width = {}, 0 --- @type integer[], integer
src[#src + 1] = p.spec.src for i, p in ipairs(plug_list) do
name_width[i] = api.nvim_strwidth(p.spec.name)
name_max_width = math.max(name_max_width, name_width[i])
end end
local src_text = table.concat(src, '\n') local lines = {} --- @type string[]
local confirm_msg = ('These plugins will be installed:\n\n%s\n'):format(src_text) for i, p in ipairs(plug_list) do
local res = vim.fn.confirm(confirm_msg, 'Proceed? &Yes\n&No\n&Always', 1, 'Question') local pad = (' '):rep(name_max_width - name_width[i] + 1)
confirm_all = res == 3 lines[i] = ('%s%sfrom %s'):format(p.spec.name, pad, p.spec.src)
end
local text = table.concat(lines, '\n')
local confirm_msg = ('These plugins will be installed:\n\n%s\n'):format(text)
local choice = vim.fn.confirm(confirm_msg, 'Proceed? &Yes\n&No\n&Always', 1, 'Question')
confirm_all = choice == 3
vim.cmd.redraw() vim.cmd.redraw()
return res ~= 2 return choice ~= 2
end end
--- @param tags string[] --- @param tags string[]
@@ -662,14 +670,6 @@ end
--- @param plug_list vim.pack.Plug[] --- @param plug_list vim.pack.Plug[]
local function install_list(plug_list, confirm) local function install_list(plug_list, confirm)
-- Get user confirmation to install plugins
if confirm and not confirm_install(plug_list) then
for _, p in ipairs(plug_list) do
p.info.err = 'Installation was not confirmed'
end
return
end
local timestamp = get_timestamp() local timestamp = get_timestamp()
--- @async --- @async
--- @param p vim.pack.Plug --- @param p vim.pack.Plug
@@ -688,7 +688,18 @@ local function install_list(plug_list, confirm)
trigger_event(p, 'PackChanged', 'install') trigger_event(p, 'PackChanged', 'install')
end end
run_list(plug_list, do_install, 'Installing plugins')
-- Install possibly after user confirmation
if not confirm or confirm_install(plug_list) then
run_list(plug_list, do_install, 'Installing plugins')
end
-- Ensure that not installed plugins are absent in lockfile
for _, p in ipairs(plug_list) do
if not p.info.installed then
plugin_lock.plugins[p.spec.name] = nil
end
end
end end
--- @async --- @async
@@ -845,11 +856,6 @@ function M.add(specs, opts)
if #plugs_to_install > 0 then if #plugs_to_install > 0 then
git_ensure_exec() git_ensure_exec()
install_list(plugs_to_install, opts.confirm) install_list(plugs_to_install, opts.confirm)
for _, p in ipairs(plugs_to_install) do
if not p.info.installed then
plugin_lock.plugins[p.spec.name] = nil
end
end
end end
if needs_lock_write then if needs_lock_write then

View File

@@ -387,18 +387,22 @@ describe('vim.pack', function()
end) end)
it('asks for installation confirmation', function() it('asks for installation confirmation', function()
-- Do not confirm installation to see what happens -- Do not confirm installation to see what happens (should not error)
mock_confirm(2) mock_confirm(2)
local err = pcall_err(exec_lua, function() exec_lua(function()
vim.pack.add({ repos_src.basic }) vim.pack.add({ repos_src.basic, { src = repos_src.defbranch, name = 'other-name' } })
end) end)
matches('`basic`:\nInstallation was not confirmed', err)
eq(false, exec_lua('return pcall(require, "basic")')) eq(false, exec_lua('return pcall(require, "basic")'))
eq(false, exec_lua('return pcall(require, "defbranch")'))
local confirm_msg = 'These plugins will be installed:\n\n' .. repos_src.basic .. '\n' local confirm_msg_lines = ([[
local ref_log = { { confirm_msg, 'Proceed? &Yes\n&No\n&Always', 1, 'Question' } } These plugins will be installed:
basic from %s
other-name from %s]]):format(repos_src.basic, repos_src.defbranch)
local confirm_msg = vim.trim(vim.text.indent(0, confirm_msg_lines))
local ref_log = { { confirm_msg .. '\n', 'Proceed? &Yes\n&No\n&Always', 1, 'Question' } }
eq(ref_log, exec_lua('return _G.confirm_log')) eq(ref_log, exec_lua('return _G.confirm_log'))
end) end)