feat: component to show real-time notification with output summary

[jedrzejboczar]

Adds a component that can be used as a replacement to on_complete_notify. on_output_notify will display a notification with task summary for long running tasks. This is helpful to get quick feedback without opening the overseer taskbar. This new component makes use of nvim-notify to update the existing notification window, so when nvim-notify is not installed it will notify only when the task completes (and will display a one-time warning about nvim-notify).

To replace on_complete_notify:

require('overseer').setup {
    component_aliases = {
        default = {
          { "display_duration", detail_level = 2 },
          "on_output_summarize",
          "on_exit_set_status",
          "on_output_notify", -- replaces on_complete_notify
          { "on_complete_dispose", require_view = { "SUCCESS", "FAILURE" } },
        },
    },
}

Example screencast:

overseer_on_output_notify.mp4

[jedrzejboczar]

Added trim parameter which is enabled by default because leading/ending whitespace in a small summary window is just wasting valuable space.

[stevearc]

Looks neat! Left some comments, but on board with the component overall.

[stevearc]

Let's take this and put it in a long_desc field on the component. That will ensure that it gets added to the documentation

[jedrzejboczar]

Done

[stevearc]

Remove when detail > 1 because this doesn't consider the task list detail setting

[jedrzejboczar]

done

[stevearc]

Not really a minimum, right? This is just the amount of time to delay before showing the notification. Maybe a name like delay_ms or show_after_ms would make more sense

[jedrzejboczar]

Changed to delay_ms

[stevearc]

based on the description, I'm not sure why anyone would ever want this to be false. It sounds like the false behavior will update the notification with the output every time there is a change in the output, except for after the process completes. Wouldn't that just ensure that the final notification is stale and doesn't show the last line(s) of the task after completed?

[jedrzejboczar]

This doesn't prevent showing the notification after completion, it just configures if the completion notification to shows the last lines of task output. I.e. (with output_on_complete=false) during runtime we notify with status (RUNNING) and last output, while on completion we notify with status (e.g. SUCCESS) without output lines.

I changed the description and added long_desc so it should now be clearer.

[stevearc]

This is a lot of tricky logic. Let's try to find a way to share it instead of copying it.

[jedrzejboczar]

Moved to overseer.util

[stevearc]

The whole point of this is to leverage nvim-notify; we only support fallback behavior when it is not present. Let's call out nvim-notify and be clearer about the intended use case for this component.

[jedrzejboczar]

Added explicit note about nvim-notify

[stevearc]

Overseer does still support Neovim 0.8. Let's do a local uv = vim.uv or vim.loop at the top of this file and use that.

[jedrzejboczar]

done

[stevearc]

You don't need a separate parameter here; you could just check the task status

if task:is_running() and not has_nvim_notify() then

[jedrzejboczar]

done

[jedrzejboczar]

Applied the suggestions. I'm not squashing yet to make review easier.

[jedrzejboczar]

Done

[jedrzejboczar]

Moved to overseer.util

[jedrzejboczar]

Added explicit note about nvim-notify

[jedrzejboczar]

done

[jedrzejboczar]

done

[jedrzejboczar]

done

[jedrzejboczar]

Changed to delay_ms

[jedrzejboczar]

This doesn't prevent showing the notification after completion, it just configures if the completion notification to shows the last lines of task output. I.e. (with output_on_complete=false) during runtime we notify with status (RUNNING) and last output, while on completion we notify with status (e.g. SUCCESS) without output lines.

I changed the description and added long_desc so it should now be clearer.

[stevearc]

Awesome, thanks for the PR!