roslyn.nvim

This plugin adds support for the new Roslyn-based C# language server introduced in the VS Code C# extension.

Requires at least Neovim 0.10

Setup

Install the Roslyn Language Server

1. Navigate to https://dev.azure.com/azure-public/vside/_artifacts/feed/vs-impl to see the latest package feed for Microsoft.CodeAnalysis.LanguageServer
2. Locate the version matching your OS + Arch and click to open it. For example, Microsoft.CodeAnalysis.LanguageServer.linux-x64 matches Linux-based OS in x64 architecture. Note that some OS/Arch specific packages may have an extra version ahead of the "core" non specific package.
3. On the package page, click the "Download" button to begin downloading its .nupkg a. (Note, if you need to get a copyable link for the download you can obtain it on chrome by then opening the downloads page, right clicking the file just downloaded, and hitting "copy link address"
4. .nupkg files are basically zip archives. In the case of Linux, you can use unzip on the downloaded file to unpack it.
5. Copy the contents of <zip root>/content/LanguageServer/<yourArch/ to ~/.local/share/nvim/roslyn a. if you did it right, the file ~/.local/share/nvim/roslyn/Microsoft.CodeAnalysis.LanguageServer.dll should exist now (along with many other .dlls and etc in that dir). You can also specify a custom path to it in the setup function.
6. To test it is working, cd into the aforementioned roslyn directory and invoke dotnet Microsoft.CodeAnalysis.LanguageServer.dll --version. It should output server's version.

Install the Plugin

Install seblj/roslyn.nvim using your plugin manager.

Example:

require("roslyn").setup({
    config = {
        -- Here you can pass in any options that that you would like to pass to `vim.lsp.start`
        -- The only options that I explicitly override are, which means won't have any effect of setting here are:
        --     - `name`
        --     - `cmd`
        --     - `root_dir`
        --     - `on_init`
    },
    exe = {
        "dotnet",
        vim.fs.joinpath(vim.fn.stdpath("data"), "roslyn", "Microsoft.CodeAnalysis.LanguageServer.dll"),
    },
    -- NOTE: Set `filewatching` to false if you experience performance problems.
    -- Defaults to true, since turning it off is a hack.
    -- If you notice that the server is _super_ slow, it is probably because of file watching
    -- I noticed that neovim became super unresponsive on some large codebases, and that was because
    -- it schedules the file watching on the event loop.
    -- This issue went away by disabling that capability. However, roslyn will fallback to its own
    -- file watching, which can make the server super slow to initialize.
    -- Setting this option to false will indicate to the server that neovim will do the file watching.
    -- However, in `hacks.lua` I will also just don't start off any watchers, which seems to make the server
    -- a lot faster to initialize.
    filewatching = true,
})

Settings

Settings can be passed to the setup function. The following settings are available vscode-csharp unit tests link:

code_style.formatting.new_line.insert_final_newline

csharp|background_analysis.dotnet_analyzer_diagnostics_scope
csharp|background_analysis.dotnet_compiler_diagnostics_scope
csharp|code_lens.dotnet_enable_references_code_lens
csharp|code_lens.dotnet_enable_tests_code_lens
csharp|code_style.formatting.indentation_and_spacing.indent_size
csharp|code_style.formatting.indentation_and_spacing.indent_style
csharp|code_style.formatting.indentation_and_spacing.tab_width
csharp|code_style.formatting.new_line.end_of_line
csharp|completion.dotnet_provide_regex_completions
csharp|completion.dotnet_show_completion_items_from_unimported_namespaces
csharp|completion.dotnet_show_name_completion_suggestions
csharp|highlighting.dotnet_highlight_related_json_components
csharp|highlighting.dotnet_highlight_related_regex_components
csharp|implement_type.dotnet_insertion_behavior
csharp|implement_type.dotnet_property_generation_behavior
csharp|inlay_hints.csharp_enable_inlay_hints_for_implicit_object_creation
csharp|inlay_hints.csharp_enable_inlay_hints_for_implicit_variable_types
csharp|inlay_hints.csharp_enable_inlay_hints_for_lambda_parameter_types
csharp|inlay_hints.csharp_enable_inlay_hints_for_types
csharp|inlay_hints.dotnet_enable_inlay_hints_for_indexer_parameters
csharp|inlay_hints.dotnet_enable_inlay_hints_for_literal_parameters
csharp|inlay_hints.dotnet_enable_inlay_hints_for_object_creation_parameters
csharp|inlay_hints.dotnet_enable_inlay_hints_for_other_parameters
csharp|inlay_hints.dotnet_enable_inlay_hints_for_parameters
csharp|inlay_hints.dotnet_suppress_inlay_hints_for_parameters_that_differ_only_by_suffix
csharp|inlay_hints.dotnet_suppress_inlay_hints_for_parameters_that_match_argument_name
csharp|inlay_hints.dotnet_suppress_inlay_hints_for_parameters_that_match_method_intent
csharp|quick_info.dotnet_show_remarks_in_quick_info
csharp|symbol_search.dotnet_search_reference_assemblies

mystery_language|Highlighting.dotnet_highlight_related_json_components
mystery_language|background_analysis.dotnet_analyzer_diagnostics_scope
mystery_language|background_analysis.dotnet_compiler_diagnostics_scope
mystery_language|code_lens.dotnet_enable_references_code_lens
mystery_language|code_lens.dotnet_enable_tests_code_lens
mystery_language|completion.dotnet_provide_regex_completions
mystery_language|completion.dotnet_show_completion_items_from_unimported_namespaces
mystery_language|completion.dotnet_show_name_completion_suggestions
mystery_language|highlighting.dotnet_highlight_related_regex_components
mystery_language|implement_type.dotnet_insertion_behavior
mystery_language|implement_type.dotnet_property_generation_behavior
mystery_language|quick_info.dotnet_show_remarks_in_quick_info
mystery_language|symbol_search.dotnet_search_reference_assemblies

navigation.dotnet_navigate_to_decompiled_sources

text_editor.tab_width

Example enabling inlay hints:

require("roslyn").setup({
    config = {
        settings = {
            ["csharp|inlay_hints"] = {
                csharp_enable_inlay_hints_for_implicit_object_creation = true,
                csharp_enable_inlay_hints_for_implicit_variable_types = true,
                csharp_enable_inlay_hints_for_lambda_parameter_types = true,
                csharp_enable_inlay_hints_for_types = true,
                dotnet_enable_inlay_hints_for_indexer_parameters = true,
                dotnet_enable_inlay_hints_for_literal_parameters = true,
                dotnet_enable_inlay_hints_for_object_creation_parameters = true,
                dotnet_enable_inlay_hints_for_other_parameters = true,
                dotnet_enable_inlay_hints_for_parameters = true,
                dotnet_suppress_inlay_hints_for_parameters_that_differ_only_by_suffix = true,
                dotnet_suppress_inlay_hints_for_parameters_that_match_argument_name = true,
                dotnet_suppress_inlay_hints_for_parameters_that_match_method_intent = true,
            },
        },
    },
})

Usage

1. The plugin will look for a .sln file in the parent directories of cwd, until it finds one.
2. If only one .sln file is found, it will be used to start the server. If multiple .slns are found, you have to run CSTarget to choose the proper solution file.
3. You should see two notifications, if everything goes well. The first one will say Roslyn client initialized for target <target>. It means the server is running and it has started to index your sln. The second one will say Roslyn project initialization complete. It means that the server has finished indexing of your sln.
4. The LSP features (like Go To Definition) will be available only after the mentioned notifications get shown.

Notes

• Roslyn requires that .csproj projects are referenced by the matched .sln it discovers. Otherwise, it won't discover and load suggestions for .cs files under the .csproj. Make sure you add your projects to the .sln (dotnet sln add <path-to-csproj>) or Roslyn won't load up properly!

Features

Please note that some features from the VS Code extension might not be supported by this plugin.