NotAShelf/nvf
2
1
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2025-11-08 22:45:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Merge 45c9606bc7 into 8e9186e4b8

Browse source
This commit is contained in:
Ching Pei Yang 2025-09-27 10:26:51 +00:00 • committed by GitHub
commit 09d3b24024
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
45 changed files with 266 additions and 68 deletions
Download patch file Download diff file Expand all files Collapse all files

40
docs/manual/configuring/languages/lsp.md
View file

@ -1,23 +1,41 @@
# LSP Custom Packages/Command {#sec-languages-custom-lsp-packages}
# Configuring supported LSP servers {#sec-languages-configuraing-lsp-servers}
One of the strengths of **nvf** is convenient aliases to quickly configure LSP
servers through the Nix module system. By default the LSP packages for relevant
language modules will be pulled into the closure. If this is not desirable, you
may provide **a custom LSP package** (e.g., a Bash script that calls a command)
or **a list of strings** to be interpreted as the command to launch the language
server. By using a list of strings, you can use this to skip automatic
installation of a language server, and instead use the one found in your `$PATH`
during runtime, for example:
may modify [](#opt-vim.lsp.servers._name_.cmd) (see example below).
Any other forms of configuration can be done via [](#opt-vim.lsp.servers), which
is a wrapper for the Neovim Lua API available as`vim.lsp.config()`. Getting
familiar with `:help vim.lsp.config()` may help you better understand how to
configure LSPs.
```nix
vim.languages.java = {
{
vim.languages.python = {
enable = true;
lsp = {
enable = true;
# You can now enable multiple LSPs per language
servers = ["basedpyright"];
};
};
# This expects 'jdt-language-server' to be in your PATH or in
# 'vim.extraPackages.' There are no additional checks performed to see
# if the command provided is valid.
package = ["jdt-language-server" "-data" "~/.cache/jdtls/workspace"];
# vim.lsp.servers is a wrapper for the lua API vim.lsp.config
# (see :help vim.lsp.config)
vim.lsp.servers = {
basedpyright = {
# `vim.languages.<lang>.lsp.package` is now removed, you have to
# modify the cmd field, and remember to copy over the arguments!
cmd = [(getExe pkgs.myCustomPackage) "--stdio"];
# server specific settings, see documentation of the respective language
# servers
settings = {
basedpyright.analysis.logLevel = "Error";
python.pythonPath = getExe pkgs.myPython3;
};
};
};
}
```

56
docs/release-notes/rl-0.8.md
View file

@ -28,6 +28,62 @@
align with the "hunks" themed mapping and avoid conflict with the new [neogit]
group.
- Language modules are reworked to allow more flexible and close-to-neovim-API
configs. LSP configuration options are removed from `vim.languages` and should
be done via `vim.lsp.servers`.
## Language module LSP rework
In nvf v0.8, language modules are overhauled, with a few goals in mind:
1. Get rid of our rigid "hard-coded" Lua scripts in favor of the more flexible
`setupOpts` styled options
2. Have our new API stick closer to Lua APIs, in this case `vim.lsp.config`
3. Allow enabling multiple LSPs per-language
This is, however, a big change, so breaking changes are inevitable. The most
important change is the removal of `vim.languages.<lang>.lsp.package` - you now
need to modify `vim.lsp.servers.<server>.cmd`, copying over any additional
arguments - these can be found in the source code files of the respective
language.
<!-- TODO: add [!NOTE] admonitions when available-->
The `<server>` mentioned here is the name of the language server, as shown in
`vim.languages.<lang>.lsp.servers`. This is NOT the name of the language.
Here's a quick overview at what the new language module, looks like:
```nix
{
vim.languages.python = {
enable = true;
lsp = {
enable = true;
# You can now enable multiple LSPs per language
servers = ["pyright" "python-lsp-server"];
};
};
# vim.lsp.servers is a wrapper for the lua API vim.lsp.config
# (see :help vim.lsp.config)
vim.lsp.servers = {
pyright = {
# `vim.languages.<lang>.lsp.package` is now removed, you have to
# modify the cmd field, and remember to copy over the arguments!
cmd = [(getExe pkgs.myCustomPyright) "--stdio"];
};
python-lsp-server = {
# server specific settings
settings = {
pylsp.signature.line_length = 100;
};
};
};
}
```
[NotAShelf](https://github.com/notashelf):
[typst-preview.nvim]: https://github.com/chomosuke/typst-preview.nvim

6
modules/neovim/init/lsp.nix
View file

@ -41,8 +41,7 @@ in {
servers = mkOption {
type = attrsOf lspOptions;
default = {};
example = ''
{
example = {
"*" = {
root_markers = [".git"];
capabilities = {
@ -57,8 +56,7 @@ in {
"clangd" = {
filetypes = ["c"];
};
}
'';
};
description = ''
LSP configurations that will be managed using `vim.lsp.config()` and related
utilities added in Neovim 0.11. LSPs defined here will be added to the

5
modules/plugins/languages/asm.nix
View file

@ -36,7 +36,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Assembly LSP server to use";
description = ''
Assembly LSP server to use. Customization of the servers can be done
via [](#opt-vim.lsp.servers).
'';
};
};
};

5
modules/plugins/languages/astro.nix
View file

@ -91,7 +91,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Astro LSP server to use";
description = ''
Astro LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/bash.nix
View file

@ -57,7 +57,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Bash LSP server to use";
description = ''
Bash LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/clang.nix
View file

@ -197,7 +197,10 @@ in {
enable = mkEnableOption "clang LSP support" // {default = config.vim.lsp.enable;};
servers = mkOption {
description = "The clang LSP server to use";
description = ''
The clang LSP server to use. Customization of the servers can be done
via [](#opt-vim.lsp.servers).
'';
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
};

5
modules/plugins/languages/clojure.nix
View file

@ -37,7 +37,10 @@ in {
servers = mkOption {
type = listOf (enum (attrNames servers));
default = defaultServers;
description = "Clojure LSP server to use";
description = ''
Clojure LSP server to use. Customization of the servers can be done
via [](#opt-vim.lsp.servers).
'';
};
};
};

5
modules/plugins/languages/csharp.nix
View file

@ -185,7 +185,10 @@ in {
lsp = {
enable = mkEnableOption "C# LSP support" // {default = config.vim.lsp.enable;};
servers = mkOption {
description = "C# LSP server to use";
description = ''
C# LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
};

5
modules/plugins/languages/css.nix
View file

@ -76,7 +76,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServer;
description = "CSS LSP server to use";
description = ''
CSS LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/dart.nix
View file

@ -54,7 +54,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Dart LSP server to use";
description = ''
Dart LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/elixir.nix
View file

@ -65,7 +65,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Elixir LSP server to use";
description = ''
Elixir LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/fsharp.nix
View file

@ -74,7 +74,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServer;
description = "F# LSP server to use";
description = ''
F# LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};
format = {

5
modules/plugins/languages/gleam.nix
View file

@ -37,7 +37,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Gleam LSP server to use";
description = ''
Gleam LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};
};

5
modules/plugins/languages/go.nix
View file

@ -97,7 +97,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Go LSP server to use";
description = ''
Go LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/haskell.nix
View file

@ -78,7 +78,10 @@ in {
servers = mkOption {
type = listOf (enum (attrNames servers));
default = defaultServers;
description = "Haskell LSP server to use";
description = ''
Haskell LSP server to use. Customization of the servers can be done
via [](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/hcl.nix
View file

@ -44,7 +44,10 @@ in {
servers = mkOption {
type = listOf (enum (attrNames servers));
default = defaultServers;
description = "HCL LSP server to use";
description = ''
HCL LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/helm.nix
View file

@ -53,7 +53,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Helm LSP server to use";
description = ''
Helm LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};
};

5
modules/plugins/languages/html.nix
View file

@ -60,7 +60,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "HTML LSP server to use";
description = ''
HTML LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/java.nix
View file

@ -74,7 +74,10 @@ in {
servers = mkOption {
type = listOf (enum (attrNames servers));
default = defaultServers;
description = "Java LSP server to use";
description = ''
Java LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};
};

5
modules/plugins/languages/json.nix
View file

@ -51,7 +51,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "JSON LSP server to use";
description = ''
JSON LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/just.nix
View file

@ -39,7 +39,10 @@ in {
servers = mkOption {
type = listOf (enum (attrNames servers));
default = defaultServers;
description = "Just LSP server to use";
description = ''
Just LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};
};

5
modules/plugins/languages/kotlin.nix
View file

@ -65,7 +65,10 @@ in {
servers = mkOption {
type = listOf (enum (attrNames servers));
default = defaultServers;
description = "Kotlin LSP server to use";
description = ''
Kotlin LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/lua.nix
View file

@ -66,7 +66,10 @@ in {
servers = mkOption {
type = listOf (enum (attrNames servers));
default = defaultServers;
description = "Lua LSP server to use";
description = ''
Lua LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
lazydev.enable = mkEnableOption "lazydev.nvim integration, useful for neovim plugin developers";

5
modules/plugins/languages/markdown.nix
View file

@ -69,7 +69,10 @@ in {
enable = mkEnableOption "Markdown LSP support" // {default = config.vim.lsp.enable;};
servers = mkOption {
description = "Markdown LSP server to use";
description = ''
Markdown LSP server to use. Customization of the servers can be done
via [](#opt-vim.lsp.servers).
'';
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
};

5
modules/plugins/languages/nim.nix
View file

@ -61,7 +61,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Nim LSP server to use";
description = ''
Nim LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/nix.nix
View file

@ -100,7 +100,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Nix LSP server to use";
description = ''
Nix LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/nu.nix
View file

@ -48,7 +48,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Nu LSP server to use";
description = ''
Nu LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};
};

5
modules/plugins/languages/ocaml.nix
View file

@ -76,7 +76,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "OCaml LSP server to use";
description = ''
OCaml LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/odin.nix
View file

@ -48,7 +48,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Odin LSP server to use";
description = ''
Odin LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};
};

5
modules/plugins/languages/php.nix
View file

@ -79,7 +79,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "PHP LSP server to use";
description = ''
PHP LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};
};

5
modules/plugins/languages/python.nix
View file

@ -250,7 +250,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Python LSP server to use";
description = ''
Python LSP server to use. Customization of the servers can be done
via [](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/qml.nix
View file

@ -48,7 +48,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "QML LSP server to use";
description = ''
QML LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/r.nix
View file

@ -79,7 +79,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "R LSP server to use";
description = ''
R LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/ruby.nix
View file

@ -79,7 +79,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Ruby LSP server to use";
description = ''
Ruby LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/sql.nix
View file

@ -80,7 +80,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "SQL LSP server to use";
description = ''
SQL LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/svelte.nix
View file

@ -101,7 +101,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Svelte LSP server to use";
description = ''
Svelte LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/tailwind.nix
View file

@ -156,7 +156,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Tailwindcss LSP server to use";
description = ''
Tailwindcss LSP server to use. Customization of the servers can be
done via [](#opt-vim.lsp.servers).
'';
};
};
};

5
modules/plugins/languages/terraform.nix
View file

@ -38,7 +38,10 @@ in {
servers = mkOption {
type = listOf (enum (attrNames servers));
default = defaultServers;
description = "Terraform LSP server to use";
description = ''
Terraform LSP server to use. Customization of the servers can be done
via [](#opt-vim.lsp.servers).
'';
};
};
};

5
modules/plugins/languages/ts.nix
View file

@ -230,7 +230,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Typescript/Javascript LSP server to use";
description = ''
Typescript/Javascript LSP server to use. Customization of the servers
can be done via [](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/typst.nix
View file

@ -116,7 +116,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Typst LSP server to use";
description = ''
Typst LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};

5
modules/plugins/languages/vala.nix
View file

@ -75,7 +75,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Vala LSP server to use";
description = ''
Vala LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};
};

5
modules/plugins/languages/wgsl.nix
View file

@ -39,7 +39,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "WGSL LSP server to use";
description = ''
WGSL LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};
};

5
modules/plugins/languages/yaml.nix
View file

@ -61,7 +61,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Yaml LSP server to use";
description = ''
Yaml LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};
};

5
modules/plugins/languages/zig.nix
View file

@ -69,7 +69,10 @@ in {
servers = mkOption {
type = singleOrListOf (enum (attrNames servers));
default = defaultServers;
description = "Zig LSP server to use";
description = ''
Zig LSP server to use. Customization of the servers can be done via
[](#opt-vim.lsp.servers).
'';
};
};