1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
{
lib,
pkgs,
config,
options,
...
}: let
inherit (builtins) elem;
inherit (lib) genAttrs;
inherit (lib.generators) mkLuaInline;
inherit (lib.options) mkEnableOption mkOption literalExpression;
inherit (config.vim.lib) mkMappingOption;
inherit (lib.types) enum listOf;
inherit (lib.modules) mkIf mkMerge;
inherit (lib.nvim.types) mkGrammarOption mkPluginSetupOption luaInline;
inherit (lib.nvim.lua) toLuaObject;
inherit (lib.nvim.dag) entryAnywhere;
inherit (lib.nvim.binds) addDescriptionsToMappings;
defaultServers = ["csharp_ls"];
servers = ["csharp_ls" "omnisharp" "roslyn-ls"];
defaultFormat = [];
formats = ["csharpier" "astyle" "injected"];
# Verbose names for clarity.
shouldEnableExclusiveLspExtension = extension: lsp: cfg.lsp.enable && cfg.extensions.${extension}.enable && (elem lsp cfg.lsp.servers);
mkAlertForMisuseOfExclusiveLspExtension = extension: lsp: (mkIf (cfg.lsp.enable
&& cfg.extensions.${extension}.enable) {
assertion = elem lsp cfg.lsp.servers;
message = "${extension} requires ${lsp} to be listed in vim.languages.csharp.lsp.servers.";
});
cfg = config.vim.languages.csharp;
in {
options = {
vim.languages.csharp = {
enable = mkEnableOption ''
C# language support.
::: {.note}
This feature will not work if the .NET SDK is not installed.
Both `roslyn-ls` (with `roslyn-nvim`) and `csharp_ls` require the .NET SDK to function properly with Razor.
Ensure that the .NET SDK is installed.
Check for version compatibility for optimal performance.
:::
::: {.warning}
At the moment, only `roslyn-ls`(with roslyn-nvim) provides full Razor support.
`csharp_ls` is limited to `.cshtml` files.
:::
'';
extensions = {
roslyn-nvim = {
enable = mkEnableOption ''
Roslyn LSP plugin for Neovim that adds Razor support and works with multiple solutions
::: {.note}
This feature only works for `roslyn-ls`.
:::
'';
setupOpts = mkPluginSetupOption "roslyn-nvim" {
filewatching = mkOption {
description = ''
"auto" | "roslyn" | "off"
- "auto": Does nothing for filewatching, leaving everything as default
- "roslyn": Turns off neovim filewatching which will make roslyn do the filewatching
- "off": Hack to turn off all filewatching.
::: {.tip}
Set to "off" if you notice performance issues
:::
'';
type = enum ["auto" "roslyn" "off"];
default = "auto";
};
extensions.razor = {
enabled =
(mkEnableOption "Additional roslyn extensions (for example Roslynator/Razor)")
// {default = true;};
config = mkOption {
description = "Configuration for the additional roslyn extensions";
type = luaInline;
default = let
pkg = pkgs.vscode-extensions.ms-dotnettools.csharp;
pluginRoot = "${pkg}/share/vscode/extensions/ms-dotnettools.csharp";
razorExtension = "${pluginRoot}/.razorExtension/Microsoft.VisualStudioCode.RazorExtension.dll";
razorSourceGenerator = "${pluginRoot}/.razorExtension/Microsoft.CodeAnalysis.Razor.Compiler.dll";
razorDesignTimePath = "${pluginRoot}/.razorExtension/Targets/Microsoft.NET.Sdk.Razor.DesignTime.targets";
in
mkLuaInline ''
function()
return {
path = '${razorExtension}',
args = {
'--razorSourceGenerator=${razorSourceGenerator}',
'--razorDesignTimePath=${razorDesignTimePath}',
},
}
end
'';
};
};
};
};
omnisharp-extended-lsp-nvim = {
enable = mkEnableOption ''
Extended 'textDocument/definition' handler for OmniSharp Neovim LSP
::: {.note}
This feature only works for `omnisharp`.
:::
'';
mappings = let
inherit (config.vim.lsp) mappings;
in {
goToDefinition = mkMappingOption "Go to definition [omnisharp-extended-lsp-nvim]" mappings.goToDefinition;
goToType = mkMappingOption "Go to type [omnisharp-extended-lsp-nvim]" mappings.goToType;
listReferences = mkMappingOption "List references [omnisharp-extended-lsp-nvim]" mappings.listReferences;
listImplementations = mkMappingOption "List implementations [omnisharp-extended-lsp-nvim]" mappings.listImplementations;
};
};
csharpls-extended-lsp-nvim = {
enable = mkEnableOption ''
Extended 'textDocument/definition' handler for csharp_ls Neovim LSP
::: {.note}
This feature only works for `csharp_ls`.
:::
'';
};
};
treesitter = {
enable =
mkEnableOption "C# treesitter"
// {
default = config.vim.languages.enableTreesitter;
defaultText = literalExpression "config.vim.languages.enableTreesitter";
};
csPackage = mkGrammarOption pkgs "c_sharp";
razorPackage = mkGrammarOption pkgs "razor";
};
lsp = {
enable =
mkEnableOption "C# LSP support"
// {
default = config.vim.lsp.enable;
defaultText = literalExpression "config.vim.lsp.enable";
};
servers = mkOption {
description = "C# LSP server to use";
type = listOf (enum servers);
default = defaultServers;
};
};
format = {
enable =
mkEnableOption "C# formatting"
// {
default = config.vim.languages.enableFormat;
defaultText = literalExpression "config.vim.languages.enableFormat";
};
type = mkOption {
description = "C# formatter to use";
type = listOf (enum formats);
default = defaultFormat;
};
};
};
};
config = mkIf cfg.enable (mkMerge [
(mkIf cfg.treesitter.enable {
vim.treesitter.enable = true;
vim.treesitter.grammars = with cfg.treesitter; [csPackage razorPackage];
})
(mkIf cfg.lsp.enable {
vim = {
luaConfigRC.razorFileTypes = ''
-- Set unknown file types!
vim.filetype.add {
extension = {
razor = "razor",
cshtml = "razor",
},
}
'';
lsp = {
presets = genAttrs cfg.lsp.servers (_: {enable = true;});
servers = genAttrs cfg.lsp.servers (_: {
filetypes = ["cs" "razor" "vb"];
});
};
};
})
(mkIf cfg.format.enable {
vim.formatter.conform-nvim = {
enable = true;
presets = genAttrs cfg.format.type (_: {enable = true;});
setupOpts.formatters_by_ft.cs = cfg.format.type;
};
})
{
assertions = [
(mkAlertForMisuseOfExclusiveLspExtension "roslyn-nvim" "roslyn-ls")
(mkAlertForMisuseOfExclusiveLspExtension "csharpls-extended-lsp-nvim" "csharp_ls")
(mkAlertForMisuseOfExclusiveLspExtension "omnisharp-extended-lsp-nvim" "omnisharp")
];
}
(mkIf (shouldEnableExclusiveLspExtension "roslyn-nvim" "roslyn-ls") {
vim = {
startPlugins = ["roslyn-nvim"];
pluginRC.roslyn-nvim = entryAnywhere "require('roslyn').setup(${toLuaObject cfg.extensions.roslyn-nvim.setupOpts})";
lsp.servers.roslyn-ls.enable = false;
extraPackages = with pkgs; [roslyn-ls];
};
})
(mkIf (shouldEnableExclusiveLspExtension "omnisharp-extended-lsp-nvim" "omnisharp") {
vim = {
startPlugins = ["omnisharp-extended-lsp-nvim"];
lsp.servers.omnisharp.on_attach = let
mappingDefinitions = options.vim.languages.csharp.extensions.omnisharp-extended-lsp-nvim.mappings;
mappings = addDescriptionsToMappings cfg.extensions.omnisharp-extended-lsp-nvim.mappings mappingDefinitions;
mkBinding = binding: action:
if binding.value != null
then "vim.keymap.set('n', ${toLuaObject binding.value}, ${action}, {buffer=bufnr, noremap=true, silent=true, desc=${toLuaObject binding.description}})"
else "";
in
mkLuaInline
''
function(client, bufnr)
${mkBinding mappings.goToDefinition "require('omnisharp_extended').lsp_definition"}
${mkBinding mappings.goToType "require('omnisharp_extended').lsp_type_definition"}
${mkBinding mappings.listReferences "require('omnisharp_extended').lsp_references"}
${mkBinding mappings.listImplementations "require('omnisharp_extended').lsp_implementation"}
end
'';
};
})
(mkIf (shouldEnableExclusiveLspExtension "csharpls-extended-lsp-nvim" "csharp_ls") {
vim = {
startPlugins = ["csharpls-extended-lsp-nvim"];
lsp.servers.csharp_ls.on_attach = mkLuaInline ''
function(client, bufnr)
require('csharpls_extended').buf_read_cmd_bind()
end
'';
};
})
]);
}
|