LLMSP `EXPERIMENTAL`

NOTE: This is highly experimental. LLMSP can change at any point, might be "unreleased", we don't guarantee backwards compatibility. It's a proof-of-concept.

POC to explore using LLMs to provide feedback in text editors using the Language Server Protocol.

This repo specifically interacts with Sourcegraph's endpionts to do two things:

Fetch related files in the repository using repo embedding search
Use these files as context for queries to the LLM

This logic is lifted from the Cody VS Code extension.

TODO

Stabelize the API
Versioned releases
Code cleanup
README updates for editor suggestions
Experiment with an LSP Proxy to get rich information from existing LSPs

How to use it

You'll need a Cody-enabled Sourcegraph server URL as well as a Sourcegraph Access Token.

Run `go install`. This will compile the `llmsp` binary and copy it to your `$GOPATH/bin`. This directory needs to be on your `$PATH`. Alternatively, use `go build` and copy the binary yourself.

Configure the LSP

Important bits:

Whatever you use to configure your LSP, it needs to provide a configuration in the form of:

{
  "llmsp": {
    "sourcegraph": {
      "url": "SOURCEGRAPH_URL",
      "accessToken": "SOURCEGRAPH_ACCESS_TOKEN"
    }
  }
}

See below example configurations for examples.

No plugins

if vim.fn.executable "llmsp" == 1 then
  vim.api.nvim_create_autocmd({ "BufReadPost", "BufNewFile" }, {
    pattern = { "*" },
    callback = function()
      vim.lsp.start {
        name = "llmsp",
        cmd = { "llmsp" },
        root_dir = vim.fs.dirname(vim.fs.find({ 'go.mod', '.git' }, { upward = true })[1]),
        capabilities = capabilities,
        on_attach = on_attach,
        settings = {
          llmsp = {
            sourcegraph = {
              url = "SOURCEGRAPH_URL",
              accessToken = "SOURCEGRAPH_ACCESS_TOKEN",
            },
          },
        },
      }
    end,
  })
end

neovim/nvim-lspconfig

In your Neovim LSP config:

local lspconfig = require('lspconfig')
local configs = require('lspconfig.configs')
if not configs.llmsp then
  configs.llmsp = {
    default_config = {
      cmd = { 'llmsp' },
      filetypes = { 'go' },
      root_dir = function(fname)
        return lspconfig.util.find_git_ancestor(fname)
      end,
      settings = {},
    },
  }
end

lspconfig.llmsp.setup({
  settings = {
    llmsp = {
      sourcegraph = {
        url = SOURCEGRAPH_ENDPOINT,
        accessToken = SOURCEGRAPH_ACCESSTOKEN
      }
    }
  }
})

neoclide/coc.nvim

In your coc-settings.json (open it with :CocConfig):

{
  "languageserver": {
    "llmsp": {
      "command": "llmsp",
      "rootPatterns": ["go.mod"],
      "trace.server": "verbose",
      "filetypes": ["go"],
      "settings": {
        "llmsp": {
          "sourcegraph": {
            "url": SOURCEGRAPH_ENDPOINT,
            "accessToken": SOURCEGRAPH_ACCESSTOKEN
          }
        }
      }
    }
  }
}

For other editors you are on your own :)

It's also recommended to have a way to trigger code actions while in VISUAL mode, as the text selection is used for some code actions.

Neovim tips

I've found the following setup to work rather well:

-- ...LSP keymaps
-- Trigger code actions in NORMAL and VISUAL mode
vim.keymap.set("n", "<space>ca", vim.lsp.buf.code_action, opts)
vim.keymap.set("v", "<space>ca", vim.lsp.buf.code_action, opts)

-- ... nvim-cmp settings
mapping = cmp.mapping.preset.insert({
-- ...
  ['<C-Space>'] = cmp.mapping.complete(), -- Manual trigger completions
-- ...
}),

Play around with it

Try to add your own code actions. Use the existing ones to see how to send edits back to the editor, play around with the prompts, etc.

sourcegraph/llmsp

LLMSP EXPERIMENTAL