Provide support for workspace/executeCommand LSP capability

[pmanole-volvocars]

Please consider providing support for the workspace/executeCommand LSP capability.

It should make it easier for editors like NeoVim to create on-save actions, such as running the source.organizeImports command.

textDocument/codeAction requires too many arguments and I still could not get it to work. The command seems to do nothing (see comments below).

I'm using AstroNvim, with AstroLSP plugin configured with this autocmd:

      organize_imports = {
        {
          event = { "BufWritePre" },
          desc = "Organize imports (Biome)",
          callback = function()
            local clients = vim.lsp.get_clients { bufnr = 0 }

            for _, client in ipairs(clients) do
              if client.name == "biome" then
                -- Get the entire range of the current document
                local bufnr = 0 -- Current buffer number
                local start_pos = { line = 0, character = 0 } -- Start of the document
                local end_pos = vim.api.nvim_buf_get_lines(bufnr, 0, -1, false) -- End of the document
                local end_line = #end_pos -- Last line in the document
                local range = {
                  start = start_pos,
                  ["end"] = { line = end_line - 1, character = #end_pos[end_line] },
                }

                -- Define the parameters for textDocument/codeAction
                local params = {
                  textDocument = {
                    uri = vim.uri_from_bufnr(bufnr), -- URI of the current buffer
                  },
                  context = {
                    diagnostics = {}, -- Empty diagnostics
                    only = { "source.organizeImports" }, -- Only organize imports
                  },
                  range = range, -- Full document range
                }

                client.request("textDocument/codeAction", params, function(error, result)
                  if result then
                    -- If result contains actions, execute the organizeImports action
                    for _, action in ipairs(result) do
                      if action.kind == "source.organizeImports.biome" then
                        vim.notify "Organizing imports" -- this runs
                        vim.lsp.buf.execute_command(action) -- this does nothing
                        vim.notify "Imports organized" -- this doesn't run
                      else
                        vim.notify("Action not found, actual:" .. action.kind)
                      end
                    end
                  else
                    vim.notify("Failed to organize imports with Biome:\n\n" .. vim.inspect(error), vim.log.levels.WARN)
                  end
                end)
                return -- Exit function after processing
              end
            end
          end,
        },
      },

[pmanole-volvocars]

UPDATE: Got what I wanted working:

organize_imports_biome = {
  cond = function(client) return client.name == "biome" end,
  {
    event = { "BufWritePost" }, -- has to be post, otherwise doesn't work
    callback = function()
      local clients = vim.lsp.get_clients { bufnr = 0 }

      for _, client in pairs(clients) do
        if client.name == "biome" then
          if client.server_capabilities.codeActionProvider then
            local actions_supported = client.server_capabilities.codeActionProvider
            if actions_supported and actions_supported.codeActionKinds then
              -- Now check if organizeImports is in the supported actions
              local can_organize_imports = false
              for _, action in ipairs(actions_supported.codeActionKinds) do
                if action == "source.organizeImports.biome" then
                  can_organize_imports = true
                  break
                end
              end

              if can_organize_imports then
                ---@diagnostic disable-next-line: assign-type-mismatch
                vim.lsp.buf.code_action { context = { only = { "source.organizeImports.biome" } }, apply = true }
              end
            end
          end
        end
      end
    end,
  },
},

But it's so much code.

I think the discussion can be closed though. 🐰