Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
./highlights.nix
./keymaps.nix
./lazyload.nix
./lsp.nix
./lua-loader.nix
./opts.nix
./output.nix
Expand Down
151 changes: 151 additions & 0 deletions modules/lsp.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
{
lib,
config,
...
}:
let
inherit (lib) mkOption types;
inherit (lib.nixvim) toLuaObject;

cfg = config.lsp;

serverType = types.submodule {
options = {
enable = lib.mkEnableOption "the language server";

activate = lib.mkOption {
type = types.bool;
description = ''
Whether to call `vim.lsp.enable()` for this server.
'';
default = true;
example = false;
};

package = lib.mkOption {
type = with types; nullOr package;
default = null;
description = ''
Package to use for this language server.

Alternatively, the language server should be available on your `$PATH`.
'';
};

config = mkOption {
type = with types; attrsOf anything;
description = ''
Configurations for each language server.
'';
default = { };
example = {
cmd = [
"clangd"
"--background-index"
];
root_markers = [
"compile_commands.json"
"compile_flags.txt"
];
filetypes = [
"c"
"cpp"
];
};
};
};
};
in
{
options.lsp = {
luaConfig = lib.mkOption {
type = lib.types.pluginLuaConfig;
default = { };
description = ''
Lua code configuring LSP.
'';
};

inlayHints = {
enable = lib.mkEnableOption "inlay hints globally";
};

servers = mkOption {
type = types.attrsOf serverType;
description = ''
LSP servers to enable and/or configure.

This option is implemented using neovim's `vim.lsp` lua API.
If you prefer to use [nvim-lspconfig], see [`plugins.lsp`].
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At some point, we should tweak this wording to suggest users use both lsp and plugins.lsp together.

Copy link
Member

@MattSturgeon MattSturgeon Apr 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be updated in #3234 to reference plugins.lspconfig instead.


[nvim-lspconfig]: https://github.com/neovim/nvim-lspconfig
[`plugins.lsp`]: https://nix-community.github.io/nixvim/plugins/lsp/index.html
'';
default = { };
example = {
"*".config = {
root_markers = [ ".git" ];
capabilities.textDocument.semanticTokens = {
multilineTokenSupport = true;
};
};
luals.enable = true;
clangd = {
enable = true;
config = {
cmd = [
"clangd"
"--background-index"
];
root_markers = [
"compile_commands.json"
"compile_flags.txt"
];
filetypes = [
"c"
"cpp"
];
};
};
};
};
};

config =
let
enabledServers = lib.filterAttrs (_: v: v.enable) cfg.servers;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we introduce a name option (similar to other submodule sets like extraFiles), then we can simplify this to filter (v: v.enable) (attrValues cfg.servers)

submodule (
  { name, ... }:
  {
    options = {
      name = lib.mkOption {
        type = lib.types.str;
        description = "The name of the language server, used as the first argument to `vim.lsp.enable` and `vim.lsp.config`.";
        default = name;
      };
      # ...
    };
  }
)

This would also allow users to configure the same server in different ways, using different attr-names, and decide which to use via the enable option.

Copy link
Member

@MattSturgeon MattSturgeon Apr 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll look at this in a followup PR

EDIT: #3239

in
{
extraPackages = lib.pipe enabledServers [
builtins.attrValues
(builtins.catAttrs "package")
];

lsp.luaConfig.content =
let
mkServerConfig =
name: props:
let
luaName = toLuaObject name;
in
''
vim.lsp.config(${luaName}, ${toLuaObject props.config})
''
+ lib.optionalString props.activate ''
vim.lsp.enable(${luaName})
'';
in
lib.mkMerge (
lib.optional cfg.inlayHints.enable "vim.lsp.inlay_hint.enable(true)"
++ lib.mapAttrsToList mkServerConfig enabledServers
);

extraConfigLua = lib.mkIf (cfg.luaConfig.content != "") ''
-- LSP {{{
do
${cfg.luaConfig.content}
end
-- }}}
'';
};
}
2 changes: 1 addition & 1 deletion plugins/lsp/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ lib.nixvim.plugins.mkNeovimPlugin {
if wrappers == [ ] then s else (builtins.head wrappers) (runWrappers (builtins.tail wrappers) s);
in
''
-- LSP {{{
-- nvim-lspconfig {{{
do
${cfg.preConfig}

Expand Down
30 changes: 30 additions & 0 deletions tests/test-sources/modules/lsp.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
example = {
lsp.servers = {
"*".config = {
root_markers = [ ".git" ];
capabilities.textDocument.semanticTokens = {
multilineTokenSupport = true;
};
};
luals.enable = true;
clangd = {
enable = true;
config = {
cmd = [
"clangd"
"--background-index"
];
root_markers = [
"compile_commands.json"
"compile_flags.txt"
];
filetypes = [
"c"
"cpp"
];
};
};
};
};
}