rzls.nvim is a Neovim plugin for the Razor Language Server (rzls). It provides
language server protocol (LSP) support for Razor/Blazor/CSHTML files, bringing
powerful development features to Neovim. ✨
With rzls.nvim, you can enjoy a seamless coding experience with features like
auto-completion, go-to-definition, and more all from within Neovim 💻🔧
| Feature | Support |
|---|---|
| Hover | âś… |
| Diagnositcs | âś… |
| Go To Definition | âś… |
| Go To References | âś… |
| Semantic Highlighting | âś… |
| Formatting | âś… |
| Rename Symbol | âś… |
| Signature Help | âś… |
| Completions | âś… |
| Inlay Hints | âś… |
| Code Actions | âś… |
| Folding | âś… |
| CodeLens | ❌ |
| Format New Files | ❌ |
Note
Semantic highlight groups need more configuration If you find a
property that isn't highlighted properly and is identified with :Inspect
please raise an issue, or a PR to link it to a highlight group.
The LSP can be cloned and compiled from source from the dotnet/razor repo.
Tip
Alternatively, if you use mason to manage your LSP installs. A registry
containing both Roslyn and rzls is
configured here
It can be included in your configuration like so:
require("mason").setup({
registries = {
"github:mason-org/mason-registry",
"github:Crashdummyy/mason-registry",
},
})You can pass a configuration table to the setup function. The configuration
options are:
capabilities: A table that defines the capabilities of the LSP client. If you don't know what this is, it can either be omitted or found in the documentation of your completion provider.path: The path to the rzls executable if not installed via mason. If you have installed via mason you can omit this option.on_attach: A function that is called when the LSP client attaches to a buffer. If you don't know what this is, or your on_attach function is provided by an autocommand, omit the option, or pass an empty function.
You must install the following plug-ins:
seblyng/roslyn.nvimfor general functionalityhtml-lspfor completions and formatting. You can install and configure it viamasonandnvim-lspconfig.
Caution
Please see the Integration section for extra arguments that must be passed to
roslyn.nvim setup.
You also must configure the
roslyn.nvim plugin to communicate
with the rzls. To do so, you must pass the handlers defined in the
rzls.roslyn_handlers module and adjust the CLI command that Roslyn uses.
To configure roslyn.nvim, you need to compose a shell command string with
arguments for it. Some of these arguments are CLI-options relating to rzls. You
can compose the command as follows, depending on whether you installed Roslyn
and rzls manually or with mason.
Manually:
-- Adjust these paths to where you installed Roslyn and rzls.
local roslyn_base_path = vim.fs.joinpath(vim.fn.stdpath("data"), "roslyn")
local rzls_base_path = vim.fs.joinpath(vim.fn.stdpath("data"), "rzls")
local cmd = {
"dotnet",
vim.fs.joinpath(roslyn_base_path, "Microsoft.CodeAnalysis.LanguageServer.dll"),
"--stdio",
"--logLevel=Information",
"--extensionLogDirectory=" .. vim.fs.dirname(vim.lsp.get_log_path()),
"--razorSourceGenerator=" .. vim.fs.joinpath(rzls_base_path, "Microsoft.CodeAnalysis.Razor.Compiler.dll"),
"--razorDesignTimePath="
.. vim.fs.joinpath(rzls_base_path, "Targets", "Microsoft.NET.Sdk.Razor.DesignTime.targets"),
}With mason:
local mason_registry = require("mason-registry")
local rzls_path = vim.fn.expand("$MASON/packages/rzls/libexec")
local cmd = {
"roslyn",
"--stdio",
"--logLevel=Information",
"--extensionLogDirectory=" .. vim.fs.dirname(vim.lsp.get_log_path()),
"--razorSourceGenerator=" .. vim.fs.joinpath(rzls_path, "Microsoft.CodeAnalysis.Razor.Compiler.dll"),
"--razorDesignTimePath=" .. vim.fs.joinpath(rzls_path, "Targets", "Microsoft.NET.Sdk.Razor.DesignTime.targets"),
"--extension",
vim.fs.joinpath(rzls_path, "RazorExtension", "Microsoft.VisualStudioCode.RazorExtension.dll"),
}Finally, use the composed cmd and rzls handlers like so:
require("roslyn").setup({
cmd = cmd,
config = {
-- the rest of your Roslyn configuration
handlers = require("rzls.roslyn_handlers"),
},
})return {
{
"seblyng/roslyn.nvim",
ft = { "cs", "razor" },
dependencies = {
{
-- By loading as a dependencies, we ensure that we are available to set
-- the handlers for Roslyn.
"tris203/rzls.nvim",
config = true,
},
},
config = function()
-- Use one of the methods in the Integration section to compose the command.
local cmd = {}
vim.lsp.config("roslyn", {
cmd = cmd,
handlers = require("rzls.roslyn_handlers"),
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,
},
["csharp|code_lens"] = {
dotnet_enable_references_code_lens = true,
},
},
})
vim.lsp.enable("roslyn")
end,
init = function()
-- We add the Razor file types before the plugin loads.
vim.filetype.add({
extension = {
razor = "razor",
cshtml = "razor",
},
})
end,
},
}If you use telescope.nvim
for definitions and references then you may want to add additional filtering
to exclude references in the generated virtual files.
require("telescope").setup({
defaults = {
file_ignore_patterns = { "%__virtual.cs$" },
},
})If you use trouble.nvim for
diagnostics, then you want to exclude the virtual buffers from diagnostics
require("trouble").setup({
modes = {
diagnostics = {
filter = function(items)
return vim.tbl_filter(function(item)
return not string.match(item.basename, [[%__virtual.cs$]])
end, items)
end,
},
},
})- Native Windows support doesn't work at this time, due to path normalization.
- Opening a CS file first means that Roslyn and rzls don't connect properly.
This plugin is still under construction. The Razor Language Server (rzls) uses a variety of custom methods that need to be understood and implemented. We are actively working on this and appreciate your patience.
We welcome contributions from the community for support of new features, fixing
bugs, issues or things on the TODO-list (Grep the code for TODO). If you have
experience with LSP or
Razor and would like to contribute, please open a Pull Request. If
you encounter any issues or have suggestions for improvements, please open an
Issue. Your input is valuable in making this plugin more robust and efficient.
There is a discord community linked in the discussion below, if you have anything you would like to discuss, or you want to help. Come say hi.
If you want to help out, then please see the discussion here, and leave a comment with your details in this discussion.