plugins/nvim-lsp: add extraOptions for nvim-lsp language servers (#351)

plugins/nvim-lsp/helpers.nix

@@ -20,6 +20,7 @@
     pkgs,
     config,
     lib,
+    options,
     ...
   }:
     with lib; let
@@ -84,6 +85,12 @@
                 Extra settings for the ${name} language server.
               '';
             };
+
+            extraOptions = mkOption {
+              default = {};
+              type = types.attrs;
+              description = "Extra options for the ${name} language server.";
+            };
           }
           // packageOption;
       };
@@ -98,7 +105,8 @@
           plugins.lsp.enabledServers = [
             {
               name = serverName;
-              extraOptions = {
+              extraOptions =
+                {
                   inherit (cfg) cmd filetypes autostart;
                   on_attach =
                     helpers.ifNonNull' cfg.onAttach
@@ -111,9 +119,21 @@
                       ''
                     );
                   settings = (settings cfg.settings) // cfg.extraSettings;
-              };
+                }
+                // cfg.extraOptions;
             }
           ];
+
+          warnings = let
+            extraSettingsOption = options.plugins.lsp.servers.${name}.extraSettings;
+          in
+            optional
+            (extraSettingsOption.isDefined)
+            (
+              let
+                optionPrefix = "plugins.lsp.servers.${name}";
+              in "The `${optionPrefix}.extraSettings` option is deprecated in favor of `${optionPrefix}.extraOptions.settings`."
+            );
         };
     };
 }

tests/test-sources/plugins/nvim-lsp/nvim-lsp.nix

@@ -33,6 +33,12 @@
         };
         nil_ls.enable = true;
         rust-analyzer.enable = true;
+        ruff-lsp = {
+          enable = true;
+          extraOptions = {
+            init_options.settings.args = ["--config=/path/to/config.toml"];
+          };
+        };
         pylsp = {
           enable = true;
           filetypes = ["python"];