Merge pull request #85 from sfavazza/feature/multiple-servers-support

Add multi-server feature

Author: factyy

.gitignore

@@ -27,3 +27,6 @@ emacs.d
 Debug
 .log
 *.ccls-cache*
+
+# test files
+test/.lsp-docker.yml

README.org

@@ -13,7 +13,11 @@
     - [[#flags][Flags]]
       - [[#emacs][Emacs]]
       - [[#spacemacs][Spacemacs]]
-  - [[#custom-language-server-containers][Custom language server containers]] 
+  - [[#custom-language-server-containers][Custom language server containers]]
+    - [[#building-a-container-or-an-image-manually][Building a container (or an image) manually:]]
+    - [[#registering-a-language-server-using-a-persistent-configuration-file][Registering a language server using a persistent configuration file:]]
+    - [[#registering-a-language-server-using-a-dir-locals-file][Registering a language server using a =.dir-locals= file:]]
+    - [[#automatic-image-building][Automatic image building:]]
   - [[#docker-over-tramp-tbd][Docker over TRAMP (TBD)]]
   - [[#see-also][See also]]
   - [[#maintainers][Maintainers]]
@@ -115,11 +119,11 @@
        #+begin_src bash
        EMACS_D_VOLUME=/path/to/spacemacs bash start-spacemacs.sh
        #+end_src
-       
-** Custom language server containers     
+
+** Custom language server containers
    You can use manually built language containers or images hosting language server(s), just follow a few simple rules (shown below).
    The docker images may feature an optional tag, if omitted _latest_ will be assumed.
-   
+
 *** Building a container (or an image) manually:
     You have 2 constraints:
     - A language server must be launched in =stdio= mode (other types of communication are yet to be supported)
@@ -143,6 +147,7 @@
 It is structured in the following way:
 
 #+begin_src yaml
+  # single server configuration
   lsp:
     server:
       type: docker
@@ -152,11 +157,11 @@ It is structured in the following way:
       #   (see Automatic image building). An image might feature an optional tag, i.e. '<image>:<tag>'. If a
       #   tagless image is indicated 'latest' will be assumed.
       subtype: container
-      # image/container name to use for this language server
+      # Image/container name to use for this language server.
       name: image-container-name
       # server id of a registered LSP server. You can find the list of registered servers evaluating:
       #
-      # `(let ((keys ())) (maphash (lambda (k v) (push k keys)) lsp-clients) keys)`
+      # `(ht-keys lsp-clients)`
       #
       # source:
       # https://stackoverflow.com/questions/17066169/retrieve-keys-from-hash-table-sorted-by-the-values-efficiently
@@ -169,14 +174,26 @@ It is structured in the following way:
       # NOTE: the paths must be within the project this server is being build for
       - source: "/your/host/source/path"
         destination: "/your/path/inside/the/container"
+
+  # multiple server configuration
+  lsp:
+    server:
+      - type: ...
+        subtype: ...
+        ...                       # keys as in the classic single server case, e.g. type, subtype, etc...
+      - ...                       # other single server configuration(s)
+    mappings:                     # shared among all servers
+      - source: <path-on-host>
+        destination: <path-on-lang-server>
+      ...                         # other mappings
 #+end_src
 
 *** Registering a language server using a =.dir-locals= file:
     Just refer to the source code and general conventions of using =.dir-locals=. The variable you need is =lsp-docker-persistent-default-config=, its content is merged with the =lsp= section from a configuration file (if present).
-    
+
 *** Automatic image building:
     You can also build an image automatically (currently supported only for =image= subtype): just drop the corresponding =Dockerfile= into the =.lsp-docker= folder in the project root (=Dockerfile= may be named as =Dockerfile= or =Dockerfile.lsp=). Building process is triggered by the =lsp-docker-register= call (you will be prompted whether you want to build the image). Image building *takes place in the project root* (*not* in the =.lsp-docker= subfolder)! In case of an automatic build the image will be registered automatically (based on the values from the config or =.dir-locals= file).
-    
+
     You can also troubleshoot any issues with supplemental docker calls (checking whether the required image already exists, building a new image) using the supplemental logging functionality: there are 2 variables: first you have to set =lsp-docker-log-docker-supplemental-calls= to true-like value (by default it is =nil=) and then specify the log buffer in the =lsp-docker-log-docker-supplemental-calls-buffer-name= variable (by default it is set to =*lsp-docker-supplemental-calls*=)
 
 ** Docker over TRAMP (TBD)