forked from emacs-lsp/lsp-mode
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlsp-go.el
259 lines (214 loc) · 9.67 KB
/
lsp-go.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
;;; lsp-go.el --- Go Client settings -*- lexical-binding: t; -*-
;; Copyright (C) 2019 Muir Manders
;; Author: Muir Manders <[email protected]>
;; Keywords:
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; lsp-go client
;;; Code:
(require 'lsp-mode)
(defgroup lsp-gopls nil
"LSP support for the Go Programming Language, using the gopls language server."
:link '(url-link "https://github.com/golang/go/wiki/gopls")
:group 'lsp-mode)
(defcustom lsp-gopls-use-placeholders t
"Cause gopls to provide placeholder parameter snippets when
completing function calls."
:type 'boolean
:group 'lsp-gopls)
(defcustom lsp-gopls-server-path "gopls"
"Path to gopls server binary."
:type 'string
:group 'lsp-gopls)
(defcustom lsp-gopls-server-args nil
"Extra CLI arguments for gopls."
:type '(repeat string)
:group 'lsp-gopls)
(defcustom lsp-gopls-build-flags []
"A vector of flags passed on to the build system when invoked,
applied to queries like `go list'."
:type 'lsp-string-vector
:group 'lsp-gopls
:risky t
:package-version '(lsp-mode "6.2"))
(defcustom lsp-gopls-env '()
"`gopls' has the unusual ability to set environment variables,
intended to affect the behavior of commands invoked by `gopls'
on the user's behalf. This variable takes a hash table of env
var names to desired values."
:type '(alist :key-type (string :tag "env var name") :value-type (string :tag "value"))
:group 'lsp-gopls
:risky t
:package-version '(lsp-mode "6.2"))
(defcustom lsp-gopls-hover-kind "SynopsisDocumentation"
"`gopls' allows the end user to select the desired amount of
documentation returned during e.g. hover and thing-at-point
operations."
:type '(choice (const "SynopsisDocumentation")
(const "NoDocumentation")
(const "FullDocumentation")
(const "SingleLine")
(const "Structured"))
:group 'lsp-gopls
:risky t
:package-version '(lsp-mode "6.2"))
(defvar lsp-gopls-available-codelens
'((generate . "Run `go generate` for a directory")
(test . "Run `go test` for a specific test function")
(tidy . "Run `go mod tidy` for a module")
(upgrade_dependency . "Upgrade a dependency")
(regenerate_cgo . "Regenerate cgo definitions"))
"Available codelens that can be further enabled or disabled
through `lsp-gopls-codelens'.")
(defun lsp-gopls--defcustom-available-as-alist-type (alist)
"Returns a list suitable for the `:type' field in a `defcustom' used to populate an alist.
The input ALIST has the form `((\"name\" . \"documentation sentence\") [...])'
The returned type provides a tri-state that either:
- does not include the element in the alist
- sets element to false (actually, :json-false)
- sets element to true (actually, t)
"
(let ((list '()))
(dolist (v alist)
(push `(cons
:tag ,(cdr v)
(const :format "" ,(car v))
(choice (const :tag "Enable" t) (const :tag "Disable" :json-false)))
list))
(push 'set list)
list))
(defcustom lsp-gopls-codelens '((generate . t) (test . t))
"Select what codelens should be enabled or not.
The codelens can be found at https://github.com/golang/tools/blob/4d5ea46c79fe3bbb57dd00de9c167e93d94f4710/internal/lsp/source/options.go#L102-L108."
:type (lsp-gopls--defcustom-available-as-alist-type lsp-gopls-available-codelens)
:group 'lsp-gopls
:risky t
:package-version '(lsp-mode "7.0"))
(lsp-register-custom-settings
'(("gopls.usePlaceholders" lsp-gopls-use-placeholders t)
("gopls.hoverKind" lsp-gopls-hover-kind)
("gopls.buildFlags" lsp-gopls-build-flags)
("gopls.env" lsp-gopls-env)
("gopls.codelens" lsp-gopls-codelens)))
(lsp-register-client
(make-lsp-client :new-connection (lsp-stdio-connection
(lambda () (cons lsp-gopls-server-path lsp-gopls-server-args)))
:major-modes '(go-mode go-dot-mod-mode)
:priority 0
:server-id 'gopls
:library-folders-fn 'lsp-clients-go--library-default-directories))
(defgroup lsp-clients-go nil
"LSP support for the Go Programming Language."
:group 'lsp-mode)
(defcustom lsp-clients-go-server "bingo"
"The go language server executable to use."
:group 'lsp-clients-go
:risky t
:type 'file)
(defcustom lsp-clients-go-server-args nil
"Extra arguments for the go language server."
:type '(repeat string)
:group 'lsp-clients-go)
(defcustom lsp-clients-go-func-snippet-enabled t
"Enable the returning of argument snippets on `func' completions, eg.
`func(foo string, arg2 bar)'. Requires code completion to be enabled."
:type 'boolean
:group 'lsp-clients-go)
(defcustom lsp-clients-go-gocode-completion-enabled t
"Enable code completion feature (using gocode)."
:type 'boolean
:group 'lsp-clients-go)
(defcustom lsp-clients-go-format-tool "goimports"
"The tool to be used for formatting documents. Defaults to `goimports' if nil."
:type '(choice (const :tag "goimports" "goimports")
(const :tag "gofmt" "gofmt"))
:group 'lsp-clients-go)
(defcustom lsp-clients-go-imports-local-prefix ""
"The local prefix (comma-separated string) that goimports will use."
:type 'string
:group 'lsp-clients-go)
(defcustom lsp-clients-go-max-parallelism nil
"The maximum number of goroutines that should be used to fulfill requests.
This is useful in editor environments where users do not want results ASAP,
but rather just semi quickly without eating all of their CPU. When nil,
defaults to half of your CPU cores."
:type '(choice integer (const nil "Half of CPU cores."))
:group 'lsp-clients-go)
(defcustom lsp-clients-go-use-binary-pkg-cache t
"Whether or not $GOPATH/pkg binary .a files should be used."
:type 'boolean
:group 'lsp-clients-go)
(defcustom lsp-clients-go-diagnostics-enabled t
"Whether diagnostics are enabled."
:type 'boolean
:group 'lsp-clients-go)
(defcustom lsp-clients-go-library-directories '("/usr")
"List of directories which will be considered to be libraries."
:group 'lsp-clients-go
:risky t
:type '(repeat string))
(defcustom lsp-clients-go-library-directories-include-go-modules t
"Whether or not $GOPATH/pkg/mod should be included as a library directory."
:type 'boolean
:group 'lsp-clients-go)
(defun lsp-clients-go--library-default-directories (_workspace)
"Calculate go library directories.
If `lsp-clients-go-library-directories-include-go-modules' is non-nil
and the environment variable GOPATH is set this function will return
$GOPATH/pkg/mod along with the value of
`lsp-clients-go-library-directories'."
(let ((library-dirs lsp-clients-go-library-directories))
(when (and lsp-clients-go-library-directories-include-go-modules
(or (and (not (file-remote-p default-directory)) (executable-find "go"))
(and (version<= "27.0" emacs-version) (with-no-warnings (executable-find "go" (file-remote-p default-directory))))))
(with-temp-buffer
(when (zerop (process-file "go" nil t nil "env" "GOPATH"))
(setq library-dirs
(append
library-dirs
(list
(concat
(string-trim-right (buffer-substring (point-min) (point-max)))
"/pkg/mod")))))))
(if (file-remote-p default-directory)
(mapcar (lambda (path) (concat (file-remote-p default-directory) path)) library-dirs)
library-dirs)))
(define-inline lsp-clients-go--bool-to-json (val)
(inline-quote (if ,val t :json-false)))
(defun lsp-clients-go--make-init-options ()
"Init options for golang."
`(:funcSnippetEnabled ,(lsp-clients-go--bool-to-json lsp-clients-go-func-snippet-enabled)
:disableFuncSnippet ,(lsp-clients-go--bool-to-json (not lsp-clients-go-func-snippet-enabled))
:gocodeCompletionEnabled ,(lsp-clients-go--bool-to-json lsp-clients-go-gocode-completion-enabled)
:formatTool ,lsp-clients-go-format-tool
:goimportsLocalPrefix ,lsp-clients-go-imports-local-prefix
:maxParallelism ,lsp-clients-go-max-parallelism
:useBinaryPkgCache ,lsp-clients-go-use-binary-pkg-cache
:diagnosticsEnabled ,lsp-clients-go-diagnostics-enabled))
(lsp-register-client
(make-lsp-client :new-connection (lsp-stdio-connection
(lambda () (cons lsp-clients-go-server
lsp-clients-go-server-args)))
:major-modes '(go-mode)
:priority -1
:initialization-options 'lsp-clients-go--make-init-options
:server-id 'go-bingo
:library-folders-fn 'lsp-clients-go--library-default-directories))
(lsp-register-client
(make-lsp-client :new-connection (lsp-stdio-connection "go-langserver")
:major-modes '(go-mode)
:priority -2
:initialization-options 'lsp-clients-go--make-init-options
:server-id 'go-ls
:library-folders-fn 'lsp-clients-go--library-default-directories))
(provide 'lsp-go)
;;; lsp-go.el ends here