modules/lsp: auto-import per-server custom modules

Adding a module in the following places will import the module into that
specific server's submodule.

This allows creating server-specific options.

Added a test case to ensure all custom modules correspond to an actual
server option to avoid accidental dead code.

modules/lsp/servers/custom/README.md

@@ -0,0 +1,8 @@
+# Custom LSP server modules
+
+This directory contains modules that relate to a specific server.
+Files are auto-imported into the submodule based on their name.
+
+For example, a file named `foo.nix` or `foo/default.nix` would be imported into the `lsp.servers.foo` submodule.
+
+A corresponding `lsp.servers.<name>` option must exist for every module in this directory.

modules/lsp/servers/server.nix

@@ -90,5 +90,13 @@ in
 
   imports = [
     ./server-renames.nix
-  ];
+  ]
+  # We cannot use `config._module.args.name` in imports, since `config` causes inf-rec.
+  # Therefore we can only import custom modules when we have an externally supplied `name`.
+  ++ lib.optionals (args ? name) (
+    lib.filter lib.pathExists [
+      ./custom/${args.name}.nix
+      ./custom/${args.name}/default.nix
+    ]
+  );
 }