Fidget/status updates

[schilkp]

Here is a simple integration with fidget.nvim[1] for progress reporting:

example.mp4

Currently this uses fidget's API directly. I did not look into this but there may also be a nvim-level API for LSP progress reporting, which potentially would allow for support for other status/notification plugins.

Please let me know if you want this somewhere (As an example, or integrated) - happy to PR.

local M = {}


function M.start_fidget()
    local has_fidget, fidget = pcall(require, "fidget")
    if not has_fidget then
        return
    end

    if M.fidget_progress_handle then
        M.fidget_progress_handle.message = "Abort."
        M.fidget_progress_handle:cancel()
        M.fidget_progress_handle = nil
    end

    M.fidget_progress_handle = fidget.progress.handle.create({
        title = "",
        message = "Thinking...",
        lsp_client = { name = "CodeCompanion" },
    })
end

function M.stop_fidget()
    local has_fidget, _ = pcall(require, "fidget")
    if not has_fidget then
        return
    end

    if M.fidget_progress_handle then
        M.fidget_progress_handle.message = "Done."
        M.fidget_progress_handle:finish()
        M.fidget_progress_handle = nil
    end
end

function M.setup_fidget()
    local has_fidget, _ = pcall(require, "fidget")
    if has_fidget then
        -- New AU group:
        local group = vim.api.nvim_create_augroup("CodeCompanionHooks", {})

        -- Attach:
        vim.api.nvim_create_autocmd({ "User" }, {
            pattern = "CodeCompanionRequest*",
            group = group,
            callback = function(request)
                if request.match == "CodeCompanionRequestStarted" then
                    M.start_req_fidget()
                elseif request.match == "CodeCompanionRequestFinished" then
                    M.stop_req_fidget()
                end
            end,
        })
    end
end

return M

[1] https://github.com/j-hui/fidget.nvim

[olimorris]

Awesome and thanks for sharing. That looks so clean.

I'm going to start labelling discussions so others can find them more easily.

[schilkp]

Would this make sense here?
https://codecompanion.olimorris.dev/usage/events.html

[olimorris]

I think I'm going to have a Community section in the docs site where one of the options is a UI page and I'll probably link to discussions such as these. That way people can interact with the OP's yet it gets the visibility of the doc site. What are your thoughts?

[schilkp]

Sure! Whatever you think makes sense :)

[S1M0N38]

A spinner indicating request status is a great addition, especially for non-streaming functionality. If you're considering adding this to codecompletion.nvim, I recommend checking out spinner.nvim

It's a single-file utility designed for easy integration into plugin codebases.