doc: update description of all lsp.package

This commit is contained in:
Ching Pei Yang 2023-09-23 00:28:39 +02:00
parent 0e66f6282b
commit 0843e95efa
11 changed files with 22 additions and 11 deletions

View file

@ -98,7 +98,8 @@ in {
};
package = mkOption {
description = "clang LSP server package";
description = "clang LSP server package, or the command to run as a list of strings";
example = ''[lib.getExe pkgs.jdt-language-server " - data " " ~/.cache/jdtls/workspace "]'';
type = with types; either package (listOf str);
default = servers.${cfg.lsp.server}.package;
};

View file

@ -42,7 +42,8 @@ in {
default = defaultServer;
};
package = mkOption {
description = "Dart LSP server package";
description = "Dart LSP server package, or the command to run as a list of strings";
example = ''[lib.getExe pkgs.jdt-language-server "-data" "~/.cache/jdtls/workspace"]'';
type = with types; either package (listOf str);
default = servers.${cfg.lsp.server}.package;
};

View file

@ -85,7 +85,8 @@ in {
};
package = mkOption {
description = "Go LSP server package";
description = "Go LSP server package, or the command to run as a list of strings";
example = ''[lib.getExe pkgs.jdt-language-server " - data " " ~/.cache/jdtls/workspace "]'';
type = with types; either package (listOf str);
default = servers.${cfg.lsp.server}.package;
};

View file

@ -20,7 +20,8 @@ in {
enable = mkEnableOption "Java LSP support (java-language-server)" // {default = config.vim.languages.enableLSP;};
package = mkOption {
description = "java language server";
description = "java language server package, or the command to run as a list of strings";
example = ''[lib.getExe pkgs.jdt-language-server "-data" "~/.cache/jdtls/workspace"]'';
type = with types; either package (listOf str);
default = pkgs.jdt-language-server;
};

View file

@ -134,7 +134,8 @@ in {
default = defaultServer;
};
package = mkOption {
description = "Nix LSP server package";
description = "Nix LSP server package, or the command to run as a list of strings";
example = ''[lib.getExe pkgs.jdt-language-server "-data" "~/.cache/jdtls/workspace"]'';
type = with types; either package (listOf str);
default = servers.${cfg.lsp.server}.package;
};

View file

@ -126,7 +126,8 @@ in {
};
package = mkOption {
description = "python LSP server package";
description = "python LSP server package, or the command to run as a list of strings";
example = ''[lib.getExe pkgs.jdt-language-server "-data" "~/.cache/jdtls/workspace"]'';
type = with types; either package (listOf string);
default = servers.${cfg.lsp.server}.package;
};

View file

@ -29,7 +29,8 @@ in {
enable = mkEnableOption "Rust LSP support (rust-analyzer with extra tools)" // {default = config.vim.languages.enableLSP;};
package = mkOption {
description = "rust-analyzer package";
description = "rust-analyzer package, or the command to run as a list of strings";
example = ''[lib.getExe pkgs.jdt-language-server "-data" "~/.cache/jdtls/workspace"]'';
type = with types; either package (listOf str);
default = pkgs.rust-analyzer;
};

View file

@ -91,7 +91,8 @@ in {
};
package = mkOption {
description = "SQL LSP server package";
description = "SQL LSP server package, or the command to run as a list of strings";
example = ''[lib.getExe pkgs.jdt-language-server "-data" "~/.cache/jdtls/workspace"]'';
type = with types; either package (listOf str);
default = servers.${cfg.lsp.server}.package;
};

View file

@ -77,7 +77,8 @@ in {
};
package = mkOption {
description = "Svelte LSP server package";
description = "Svelte LSP server package, or the command to run as a list of strings";
example = ''[lib.getExe pkgs.jdt-language-server "-data" "~/.cache/jdtls/workspace"]'';
type = with types; either package (listOf str);
default = servers.${cfg.lsp.server}.package;
};

View file

@ -103,7 +103,8 @@ in {
};
package = mkOption {
description = "Typescript/Javascript LSP server package";
description = "Typescript/Javascript LSP server package, or the command to run as a list of strings";
example = ''[lib.getExe pkgs.jdt-language-server "-data" "~/.cache/jdtls/workspace"]'';
type = with types; either package (listOf str);
default = servers.${cfg.lsp.server}.package;
};

View file

@ -20,7 +20,8 @@ in {
enable = mkEnableOption "Zig LSP support (zls)" // {default = config.vim.languages.enableLSP;};
package = mkOption {
description = "ZLS package";
description = "ZLS package, or the command to run as a list of strings";
example = ''[lib.getExe pkgs.jdt-language-server "-data" "~/.cache/jdtls/workspace"]'';
type = with types; either package (listOf str);
default = pkgs.zls;
};