From 0843e95efa886086adaeae46506e02cfc56a2ced Mon Sep 17 00:00:00 2001
From: Ching Pei Yang <badnam3o.0@gmail.com>
Date: Sat, 23 Sep 2023 00:28:39 +0200
Subject: [PATCH] doc: update description of all lsp.package

---
 modules/languages/clang.nix     | 3 ++-
 modules/languages/dart/dart.nix | 3 ++-
 modules/languages/go.nix        | 3 ++-
 modules/languages/java.nix      | 3 ++-
 modules/languages/nix.nix       | 3 ++-
 modules/languages/python.nix    | 3 ++-
 modules/languages/rust.nix      | 3 ++-
 modules/languages/sql.nix       | 3 ++-
 modules/languages/svelte.nix    | 3 ++-
 modules/languages/ts.nix        | 3 ++-
 modules/languages/zig.nix       | 3 ++-
 11 files changed, 22 insertions(+), 11 deletions(-)

diff --git a/modules/languages/clang.nix b/modules/languages/clang.nix
index 3235c456..d8a7cc0e 100644
--- a/modules/languages/clang.nix
+++ b/modules/languages/clang.nix
@@ -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;
       };
diff --git a/modules/languages/dart/dart.nix b/modules/languages/dart/dart.nix
index adee61fc..07623cfe 100644
--- a/modules/languages/dart/dart.nix
+++ b/modules/languages/dart/dart.nix
@@ -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;
       };
diff --git a/modules/languages/go.nix b/modules/languages/go.nix
index 1bde15b3..0c69fe55 100644
--- a/modules/languages/go.nix
+++ b/modules/languages/go.nix
@@ -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;
       };
diff --git a/modules/languages/java.nix b/modules/languages/java.nix
index f0906114..9bea591c 100644
--- a/modules/languages/java.nix
+++ b/modules/languages/java.nix
@@ -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;
       };
diff --git a/modules/languages/nix.nix b/modules/languages/nix.nix
index 81f96c58..29f00255 100644
--- a/modules/languages/nix.nix
+++ b/modules/languages/nix.nix
@@ -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;
       };
diff --git a/modules/languages/python.nix b/modules/languages/python.nix
index 8c85c270..67394715 100644
--- a/modules/languages/python.nix
+++ b/modules/languages/python.nix
@@ -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;
       };
diff --git a/modules/languages/rust.nix b/modules/languages/rust.nix
index b3ad758d..95f03a5b 100644
--- a/modules/languages/rust.nix
+++ b/modules/languages/rust.nix
@@ -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;
       };
diff --git a/modules/languages/sql.nix b/modules/languages/sql.nix
index 0f1a4e91..20b6896f 100644
--- a/modules/languages/sql.nix
+++ b/modules/languages/sql.nix
@@ -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;
       };
diff --git a/modules/languages/svelte.nix b/modules/languages/svelte.nix
index 33c0bf3a..dee46182 100644
--- a/modules/languages/svelte.nix
+++ b/modules/languages/svelte.nix
@@ -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;
       };
diff --git a/modules/languages/ts.nix b/modules/languages/ts.nix
index 8902f664..06378733 100644
--- a/modules/languages/ts.nix
+++ b/modules/languages/ts.nix
@@ -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;
       };
diff --git a/modules/languages/zig.nix b/modules/languages/zig.nix
index 2f3bcec2..0fe4c38b 100644
--- a/modules/languages/zig.nix
+++ b/modules/languages/zig.nix
@@ -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;
       };