[Feature Request] Option to run ExecutorShowDetail when the current task finishes

[Patitotective]

Just like described in the title I'd like for there to be an option that allows me to see the output of a task just after it has finished.

[Patitotective]

It could very well be something like onTaskFinishEvent so one can customize it to their liking.

[jackfranklin]

Nice idea, thanks! So are you picturing that in the config you provide a callback function? I could easily have that called when the task completes. Would that serve your purpose?

[Patitotective]

That would be perfect!

[jackfranklin]

@Patitotective sorry for the delay here; could you locally try running against #36 and see if that does the job for you?

[Patitotective]

Hi, I tried it but the callback doesn't seem to be getting called. I have this config:

return {
  "google/executor.nvim",
  branch = "callback",
  dependencies = {
    "MunifTanjim/nui.nvim",
  },
  config = function()
    require("executor").setup({
      use_split = false,
    })
  end,
  callbacks = {
    -- Called when a task completes so you can hook into the lifecycle.
    on_complete = function(last_cmd, exit_code, stdout)
      require("executor").commands.show_detail()
      vim.notify("executor done", "info")
    end,
  },
}

I ran a command with :ExecuteRun, it ended successfully but the detail popup didn't show up, nor my notification.
I tried running :lua require("executor").commands.show_detail() and it worked so I'm not sure what is wrong.

[jackfranklin]

Ah interesting. Could you wrap the body of your on_complete callback in a vim.schedule?

I wonder if that's the problem.

on_complete = vim.schedule_wrap(
  function(last_cmd, exit_code, stdout)
      require("executor").commands.show_detail()
      vim.notify("executor done", "info")
    end,)
)

If this works, then I will update my PR so that the scheduling is done in Executor and people don't have to worry about it.

[Patitotective]

Hi, it doesn't seem to be working for me :/
I tried a clean install with this config but no luck:

-- init.lua
-- Bootstrap lazy.nvim
local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
if not (vim.uv or vim.loop).fs_stat(lazypath) then
	local lazyrepo = "https://github.com/folke/lazy.nvim.git"
	local out = vim.fn.system({ "git", "clone", "--filter=blob:none", "--branch=stable", lazyrepo, lazypath })
	if vim.v.shell_error ~= 0 then
		vim.api.nvim_echo({
			{ "Failed to clone lazy.nvim:\n", "ErrorMsg" },
			{ out, "WarningMsg" },
			{ "\nPress any key to exit..." },
		}, true, {})
		vim.fn.getchar()
		os.exit(1)
	end
end
vim.opt.rtp:prepend(lazypath)

-- Make sure to setup `mapleader` and `maplocalleader` before
-- loading lazy.nvim so that mappings are correct.
-- This is also a good place to setup other settings (vim.opt)
vim.g.mapleader = " "
vim.g.maplocalleader = "\\"

-- Setup lazy.nvim
require("lazy").setup({
	spec = {
		-- add your plugins here
		{
			"google/executor.nvim",
			branch = "callback",
			dependencies = {
				"MunifTanjim/nui.nvim",
			},
			config = function()
				require("executor").setup({
					use_split = false,
				})
			end,
			callbacks = {
				-- Called when a task completes so you can hook into the lifecycle.
				on_complete = vim.schedule_wrap(function(last_cmd, exit_code, stdout)
					require("executor").commands.show_detail()
					vim.notify("executor done", "info")
				end),
			},
		},
	},
	-- Configure any other settings here. See the documentation for more details.
	-- colorscheme that will be used when installing plugins.
	install = { colorscheme = { "habamax" } },
	-- automatically check for plugin updates
	checker = { enabled = true },
})

lazy-lock.json
{
  "executor.nvim": { "branch": "callback", "commit": "5fcceacd407fd99fe6405207e4c94ccb3e2a603a" },
  "lazy.nvim": { "branch": "main", "commit": "6c3bda4aca61a13a9c63f1c1d1b16b9d3be90d7a" },
  "nui.nvim": { "branch": "main", "commit": "de740991c12411b663994b2860f1a4fd0937c130" }
}

[jackfranklin]

Thanks for reporting! Out of interest, if you remove the show_detail() call, do you see the vim.notify call?

[Patitotective]

Hi, no, I don't. Even without the vim.schedule_wrap, I don't see the notification. :/