csharpls-extended-lsp.nvim

Extended textDocument/definition and textDocument/typeDefinition handler that handles assembly/decompilation loading for $metadata$ documents.

NOTE

Now decompile action is hidden behind feature "metadata-uris", so you need add such config in your nvim lspconfig

    -- ....
    if lsp == "csharp_ls" then
        opts = {
            on_attach = on_attach,
            capabilities = capabilities,
            cmd = function(dispatchers, config)
                --- NOTE: csharp-ls is using rpc to communicate with editor, not stdout, so you need to write it in this way
                return vim.lsp.rpc.start({ 'csharp-ls', '--features', 'metadata-uris' }, dispatchers, {
                    -- csharp-ls attempt to locate sln, slnx or csproj files from cwd, so set cwd to root directory.
                    -- If cmd_cwd is provided, use it instead.
                    cwd = config.cmd_cwd or config.root_dir,
                    env = config.cmd_env,
                    detached = config.detached,
                })
            end,
            flags = {
                --allow_incremental_sync = false,
            },
        }
    end
    -- ....

How it works

By providing an alternate handler for textDocument/definition the plugin listens to all responses and if it receives URI with $metadata$ it will call custom omnisharp endpoint o#/metadata which returns full document source. This source is then loaded as a scratch buffer with name set to /$metadata$/... This allows then allows jumping to the buffer based on name or from quickfix list, because it's loaded.

csharpls use ILSpy/ICSharpCode.Decompiler to decompile code. So just get the uri and We can receive decompile sources from csahrpls

api

The api is "csharp/metadata", in neovim ,you can request it like

  local result, err = client.request_sync("csharp/metadata", params, 10000, 0) -- 0 is for current buffer

sender

You need to send a uri, it is like

csharp:/metadata/projects/trainning2/assemblies/System.Console/symbols/System.Console.cs

In neovim, it will be result(s) from vim.lsp.handles["textDocument/definition"]

and the key of uri is the key,

The key to send is like

local params = {
	timeout = 5000,
	textDocument = {
		uri = uri,
	}
}

The key of textDocument is needed. And timeout is just for neovim. It is the same if is expressed by json.

receiver

The object received is like

{
	projectName = "csharp-test",
	assemblyName = "System.Runtime",
	symbolName = "System.String",
	source = "using System.Buffers;\n ...."
}

And In neovim, You receive the "result" above, you can get the decompile source from

local result, err = client.request_sync("csharp/metadata", params, 10000, 0)
local source
if not err then
	source = result.result.source	
end

Usage

To use this plugin all that needs to be done is for the nvim lsp handler for textDocument/definition be overridden with one provided by this plugin.

If using lspconfig this can be done like this:

First configure omnisharp as per nvim-lspconfig.

Then to that config add handlers with custom handlers from this plugin.

For nvim < 0.11

local config = {
  handlers = {
    ["textDocument/definition"] = require('csharpls_extended').handler,
    ["textDocument/typeDefinition"] = require('csharpls_extended').handler,
  },
  cmd = { csharpls },
  -- rest of your settings
}
require'lspconfig'.csharp_ls.setup(config)

For nvim 0.11

require'lspconfig'.csharp_ls.setup(config)
require("csharpls_extended").buf_read_cmd_bind()

Telescope

require("telescope").load_extension("csharpls_definition")

Thanks to omnisharp-extended-lsp.nvim

Thanks to the help of csharp-language-server