Using fish-lsp's commands

[ndonfris]

Showing the new onExecuteCommand() handler

Important

Initially included in release version 1.0.5

This handler allows clients to call lsp defined commands.

The commands will then be run on the server. Once the server completes the command, a popup formatting the output of the command will be displayed in the client.

---

Note

using coc.nvim to run these commands

Therefore, the following examples use: CocCommand fish-lsp.cmd <Args...> to be executed

---

fish-lsp.executeLine

Executes the line specified in the file.

Command requires fish-lsp.executeLine <Filepath> <LineNumber>

:CocCommand fish-lsp.executeLine /tmp/foo.fish 8

---

fish-lsp.execute and fish-lsp.executeBuffer

Executes the entire file. execute and executeBuffer are equivalent commands.

Command requires fish-lsp.execute <Filepath>

:CocCommand fish-lsp.execute /tmp/foo.fish 

---

Note

There is also fish-lsp.createTheme which needs further testing

---

Useful Client Example

Here is a simple neovim configuaration to bind the command's above to a keybinding

~/.config/nvim/lua/ftplugin/fish.lua

-- Function to get the current filename
local function get_current_filename()
  local filename = vim.api.nvim_buf_get_name(0)
  if filename == "" then
    vim.api.nvim_err_writeln("No file name available")
    return nil
  end
  return filename
end

-- Function to run fish-lsp.executeLine at the current line
local function fish_lsp_run_file_at_line()
  local filename = get_current_filename()
  if not filename then return end
  
  local linenumber = vim.api.nvim_win_get_cursor(0)[1]
  local command = string.format(":CocCommand fish-lsp.executeLine %s %d", filename, linenumber)
  vim.cmd(command)
end

-- Function to run fish-lsp.executeLine for the whole buffer
local function fish_lsp_execute_buffer()
  local filename = get_current_filename()
  if not filename then return end
  
  local command = string.format(":CocCommand fish-lsp.execute %s", filename)
  vim.cmd(command)
end

-- Map the functions to keybindings
vim.keymap.set('n', '<leader>el', fish_lsp_run_file_at_line, { noremap = true, silent = true })
vim.keymap.set('n', '<leader>eb', fish_lsp_execute_buffer, { noremap = true, silent = true })

If you're using a client other than coc.nvim be sure to edit the relevant locations in the above snippet

---

More commands will be included with future fish-lsp releases.

Ideas for new commands, other client configurations, or any any other relevant information here!