Skip to content

Commit 9247c94

Browse files
factyyfactyy
authored
Merge pull request #89 from factyy/feature/launch-parameters-support
Add (docker or podman) launch parameters support
2 parents 5554349 + 373632a commit 9247c94

File tree

2 files changed

+45
-12
lines changed

2 files changed

+45
-12
lines changed

‎README.org

+6
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,12 @@ It is structured in the following way:
166166
# source:
167167
# https://stackoverflow.com/questions/17066169/retrieve-keys-from-hash-table-sorted-by-the-values-efficiently
168168
server: server-id-of-the-base-server
169+
# an (optional) array of parameters (docker or podman) to launch the image with
170+
# initially intended to host the '--userns' parameter
171+
# NOTE: 'launch_parameters' are not used with 'container' subtype servers
172+
# in this case embed all required parameters when creating the server instead
173+
launch_parameters:
174+
- "--userns=nomap"
169175
# command to launch the language server in stdio mode
170176
# NOTE: 'launch_command' is not used with 'container' subtype servers as a command is embedded in a
171177
# container itself and serves as entrypoint

‎lsp-docker.el

+39-12
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,10 @@ name of the container/image for the described language server.")
8181
"Server ID of a registered LSP server. You can find the list of
8282
registered servers evaluating: `(ht-keys lsp-clients)'.")
8383

84+
(defconst lsp-docker--srv-cfg-launch-parameters-key 'launch_parameters
85+
"Command parameters (docker or podman) to launch the language server with.
86+
Pay attention that these parameters have to be supported by the selected subtype.")
87+
8488
(defconst lsp-docker--srv-cfg-launch-command-key 'launch_command
8589
"Command to launch the language server in stdio mode. This key is
8690
not used when the `lsp-docker--srv-cfg-subtype-key' is set to
@@ -119,23 +123,26 @@ Argument PATH the path to translate."
119123
(defvar lsp-docker-command "docker"
120124
"The docker command to use.")
121125

122-
(defun lsp-docker-launch-new-container (docker-container-name path-mappings docker-image-id server-command)
126+
(defun lsp-docker-launch-new-container (docker-container-name path-mappings launch-parameters docker-image-id server-command)
123127
"Return the docker command to be executed on host.
124128
Argument DOCKER-CONTAINER-NAME name to use for container.
125129
Argument PATH-MAPPINGS dotted pair of (host-path . container-path).
126130
Argument DOCKER-IMAGE-ID the docker container to run language servers with.
131+
Argument LAUNCH-PARAMETERS parameters (for docker or podman) to run language servers with.
127132
Argument SERVER-COMMAND the language server command to run inside the container."
128-
(split-string
129-
(--doto (format "%s run --name %s --rm -i %s %s %s"
130-
lsp-docker-command
131-
docker-container-name
132-
(->> path-mappings
133-
(-map (-lambda ((path . docker-path))
134-
(format "-v %s:%s" path docker-path)))
135-
(s-join " "))
136-
docker-image-id
137-
server-command))
138-
" "))
133+
(-remove #'s-blank?
134+
(split-string
135+
(format "%s run --name %s --rm -i %s %s %s %s"
136+
lsp-docker-command
137+
docker-container-name
138+
(->> path-mappings
139+
(-map (-lambda ((path . docker-path))
140+
(format "-v %s:%s" path docker-path)))
141+
(s-join " "))
142+
(s-join " " launch-parameters)
143+
docker-image-id
144+
server-command)
145+
" ")))
139146

140147
(defun lsp-docker-exec-in-container (docker-container-name server-command)
141148
"Return command to exec into running container.
@@ -157,6 +164,7 @@ Argument SERVER-COMMAND the command to execute inside the running container."
157164
(cl-defun lsp-docker-register-client (&key server-id
158165
docker-server-id
159166
path-mappings
167+
launch-parameters
160168
docker-image-id
161169
docker-container-name
162170
priority
@@ -177,6 +185,7 @@ Argument SERVER-COMMAND the command to execute inside the running container."
177185
(funcall (or launch-server-cmd-fn #'lsp-docker-launch-new-container)
178186
docker-container-name-full
179187
path-mappings
188+
launch-parameters
180189
docker-image-id
181190
server-command)))
182191
:test? (lambda (&rest _)
@@ -279,6 +288,7 @@ the docker container to run the language server."
279288
default-docker-container-name)
280289
:server-command server-command
281290
:path-mappings path-mappings
291+
:launch-parameters nil
282292
:launch-server-cmd-fn #'lsp-docker-launch-new-container))
283293
client-configs)))
284294

@@ -371,6 +381,13 @@ be bigger than default servers in order to override them)")
371381
(if (equal lsp-server-subtype "image")
372382
(gethash 'name server-config))))
373383

384+
(defun lsp-docker--get-server-launch-parameters (server-config)
385+
"Get the server launch parameters from the SERVER-CONFIG hash-table"
386+
(let ((launch-parameters (gethash lsp-docker--srv-cfg-launch-parameters-key server-config)))
387+
(if (or (vectorp launch-parameters)
388+
(not launch-parameters))
389+
launch-parameters
390+
(user-error "Cannot find the right launch parameters"))))
374391

375392
(defun lsp-docker-get-server-id (server-config)
376393
"Get the server id from the SERVER-CONFIG hash-table"
@@ -579,6 +596,7 @@ output)"
579596
server-id
580597
docker-server-id
581598
path-mappings
599+
launch-parameters
582600
image-name
583601
docker-container-name
584602
activation-fn
@@ -589,6 +607,7 @@ output)"
589607
:server-id ',server-id
590608
:docker-server-id ',docker-server-id
591609
:path-mappings ',path-mappings
610+
:launch-parameters ,launch-parameters
592611
:docker-image-id ',image-name
593612
:docker-container-name ',docker-container-name
594613
:activation-fn ,activation-fn
@@ -601,6 +620,7 @@ output)"
601620
server-id
602621
docker-server-id
603622
path-mappings
623+
launch-parameters
604624
docker-container-name
605625
activation-fn
606626
server-command
@@ -630,6 +650,7 @@ output)"
630650
server-id
631651
docker-server-id
632652
path-mappings
653+
launch-parameters
633654
image-name
634655
docker-container-name
635656
activation-fn
@@ -640,6 +661,7 @@ output)"
640661
(cl-defun lsp-docker-register-client-with-activation-fn (&key server-id
641662
docker-server-id
642663
path-mappings
664+
launch-parameters
643665
docker-image-id
644666
docker-container-name
645667
activation-fn
@@ -661,6 +683,7 @@ output)"
661683
(funcall (or launch-server-cmd-fn #'lsp-docker-launch-new-container)
662684
docker-container-name
663685
path-mappings
686+
launch-parameters
664687
docker-image-id
665688
server-command)))
666689
:test? (lambda (&rest _)
@@ -686,6 +709,7 @@ dockerized server."
686709
(server-image-name (lsp-docker-get-server-image-name server-config))
687710
(regular-server-id (lsp-docker-get-server-id server-config))
688711
(server-id (lsp-docker-generate-docker-server-id server-config (lsp-workspace-root)))
712+
(server-launch-parameters (lsp-docker--get-server-launch-parameters server-config))
689713
(server-launch-command (lsp-docker-get-launch-command server-config))
690714
(base-client (lsp-docker--get-base-client regular-server-id))
691715
(activation-fn (lsp-docker--create-activation-function-by-project-dir-and-base-client
@@ -706,6 +730,7 @@ dockerized server."
706730
:server-id regular-server-id
707731
:docker-server-id server-id
708732
:path-mappings path-mappings
733+
:launch-parameters server-launch-parameters
709734
:docker-image-id server-image-name
710735
:docker-container-name server-container-name
711736
:activation-fn activation-fn
@@ -718,6 +743,7 @@ dockerized server."
718743
:server-id regular-server-id
719744
:docker-server-id server-id
720745
:path-mappings path-mappings
746+
:launch-parameters server-launch-parameters
721747
:docker-container-name server-container-name
722748
:activation-fn activation-fn
723749
:server-command server-launch-command)))
@@ -726,6 +752,7 @@ dockerized server."
726752
:server-id regular-server-id
727753
:docker-server-id server-id
728754
:path-mappings path-mappings
755+
:launch-parameters nil
729756
:docker-image-id nil
730757
:docker-container-name server-container-name
731758
:activation-fn activation-fn

0 commit comments

Comments
 (0)