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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
|
;;; lsp-fsharp.el --- description -*- lexical-binding: t; -*-
;; Copyright (C) 2019 Reed Mullanix
;; Author: Reed Mullanix <reedmullanix@gmail.com>
;; 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-fsharp client
;;; Code:
(require 'lsp-mode)
(defgroup lsp-fsharp nil
"LSP support for the F# Programming Language, using the FsharpAutoComplete server."
:link '(url-link "https://github.com/fsharp/FsAutoComplete")
:group 'lsp-mode
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-fsharp-server-install-dir (f-join lsp-server-install-dir "fsautocomplete/")
"Install directory for fsautocomplete server.
The slash is expected at the end."
:group 'lsp-fsharp
:risky t
:type 'directory
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-fsharp-server-args nil
"Extra arguments for the F# language server."
:type '(repeat string)
:group 'lsp-fsharp
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-fsharp-keywords-autocomplete t
"Provides keywords in autocomplete list."
:group 'lsp-fsharp
:type 'boolean
:package-version '(lsp-mode . "6.2"))
(defcustom lsp-fsharp-external-autocomplete nil
"Provides autocompletion for symbols from not opened namespaces/modules;
inserts open on accept."
:group 'lsp-fsharp
:type 'boolean
:package-version '(lsp-mode . "6.2"))
(defcustom lsp-fsharp-linter t
"Enables FSharpLint integration, provides additional warnings and code
action fixes."
:group 'lsp-fsharp
:type 'boolean
:package-version '(lsp-mode . "6.2"))
(defcustom lsp-fsharp-union-case-stub-generation t
"Enables a code action to generate pattern matching cases."
:group 'lsp-fsharp
:type 'boolean
:package-version '(lsp-mode . "6.2"))
(defcustom lsp-fsharp-union-case-stub-generation-body "failwith \"Not Implemented\""
"Defines dummy body used by pattern matching generator."
:group 'lsp-fsharp
:type 'string
:risky t
:package-version '(lsp-mode . "6.2"))
(defcustom lsp-fsharp-record-stub-generation t
"Enables code action to generate record stub."
:group 'lsp-fsharp
:type 'boolean
:package-version '(lsp-mode . "6.2"))
(defcustom lsp-fsharp-record-stub-generation-body "failwith \"Not Implemented\""
"Defines dummy body used by record stub generator."
:group 'lsp-fsharp
:type 'string
:risky t
:package-version '(lsp-mode . "6.2"))
(defcustom lsp-fsharp-interface-stub-generation t
"Enables code action to generate an interface stub."
:group 'lsp-fsharp
:type 'boolean
:package-version '(lsp-mode . "6.2"))
(defcustom lsp-fsharp-interface-stub-generation-object-identifier "this"
"Defines object identifier used by interface stub generator,
e.g. `this' or `self'."
:group 'lsp-fsharp
:type 'string
:package-version '(lsp-mode . "6.2"))
(defcustom lsp-fsharp-interface-stub-generation-method-body "failwith \"Not Implemented\""
"Defines dummy body used by interface stub generator."
:group 'lsp-fsharp
:type 'string
:risky t
:package-version '(lsp-mode . "6.2"))
(defcustom lsp-fsharp-unused-opens-analyzer t
"Enables unused open detection."
:group 'lsp-fsharp
:type 'boolean
:package-version '(lsp-mode . "6.2"))
(defcustom lsp-fsharp-unused-declarations-analyzer t
"Enables unused symbol detection."
:group 'lsp-fsharp
:type 'boolean
:package-version '(lsp-mode . "6.2"))
(defcustom lsp-fsharp-simplify-name-analyzer nil
"Enables simplify name analyzer and remove redundant qualifier quick fix."
:group 'lsp-fsharp
:type 'boolean
:package-version '(lsp-mode . "6.2"))
(defcustom lsp-fsharp-resolve-namespaces t
"Enables resolve namespace quick fix; adds `open' if symbol is from not yet
opened module/namespace."
:group 'lsp-fsharp
:type 'boolean
:package-version '(lsp-mode . "6.2"))
(defcustom lsp-fsharp-enable-reference-code-lens t
"Enables reference count code lenses.
It is recommended to disable if `--background-service-enabled' is not used."
:group 'lsp-fsharp
:type 'boolean
:package-version '(lsp-mode . "6.2"))
(defcustom lsp-fsharp-auto-workspace-init nil
"Enable automatic workspace initialization.
Do note that this can cause unexpected or challenging behaviors, as solutions
with test projects are not autoloaded by FSharpAutoComplete."
:group 'lsp-fsharp
:type 'boolean
:risky t)
(defcustom lsp-fsharp-generate-binlog nil
"Generate a binlog for debugging project cracking."
:group 'lsp-fsharp
:type 'boolean
:package-version '(lsp-mode . "8.0.1"))
(defun lsp-fsharp--fsac-install (_client callback error-callback update?)
"Install/update fsautocomplete language server using `dotnet tool'.
Will invoke CALLBACK or ERROR-CALLBACK based on result. Will update if UPDATE? is t"
(lsp-async-start-process
callback
error-callback
"dotnet" "tool" (if update? "update" "install") "-g" "fsautocomplete"))
(defun lsp-fsharp--make-launch-cmd ()
"Build the command required to launch fsautocomplete."
;; latest emacs-28 (on macOS) and master (as of Sat Feb 12 2022) has an issue
;; that it launches processes using posix_spawn but does not reset sigmask properly
;; thus causing dotnet runtime to lockup awaiting a SIGCHLD signal that never comes
;; from subprocesses that quit
;;
;; as a workaround we will wrap fsautocomplete invocation in "/usr/bin/env --default-signal"
;; (on linux) and "/bin/ksh -c" (on macos) so it launches with proper sigmask
;;
;; see https://lists.gnu.org/archive/html/emacs-devel/2022-02/msg00461.html
;; --
;; we also try to resolve full path to fsautocomplete using `executable-find' as
;; our `startup-wrapper' may use $PATH to interpret the location of fsautocomplete
;; and we want to actually use `exec-path' here
(let ((startup-wrapper (cond ((and (eq 'darwin system-type)
(version<= "28.0" emacs-version))
(list "/bin/ksh" "-c"))
((and (eq 'gnu/linux system-type)
(version<= "29.0" emacs-version))
(list "/usr/bin/env" "--default-signal"))
(t nil)))
(fsautocomplete-exec (or (executable-find "fsautocomplete")
(f-join (or (getenv "USERPROFILE") (getenv "HOME"))
".dotnet" "tools" "fsautocomplete"))))
(append startup-wrapper
(list fsautocomplete-exec "--background-service-enabled")
lsp-fsharp-server-args)))
(defun lsp-fsharp--test-fsautocomplete-present ()
"Return non-nil if dotnet tool fsautocomplete is installed globally."
(string-match-p "fsautocomplete"
(shell-command-to-string "dotnet tool list -g")))
(defun lsp-fsharp--project-list ()
"Get the list of files we need to send to fsharp/workspaceLoad."
(let* ((response (lsp-request "fsharp/workspacePeek"
`(:directory ,(lsp-workspace-root)
:deep 10
:excludedDirs ["paket-files" ".git" "packages" "node_modules"])))
(data (lsp--read-json (lsp-get response :content)))
(found (-> data (lsp-get :Data) (lsp-get :Found)))
(directory (seq-find (lambda (d) (equal "directory" (lsp-get d :Type))) found)))
(-> directory (lsp-get :Data) (lsp-get :Fsprojs))))
;;;###autoload
(defun lsp-fsharp--workspace-load (projects)
"Load all of the provided PROJECTS."
(lsp-request-async "fsharp/workspaceLoad"
`(:textDocuments ,(vconcat [] (mapcar (lambda (p) `(:uri ,p)) projects)))
(lambda (_)
(lsp--info "Workspace Loaded!"))))
(defvar lsp-fsharp--default-init-options (list)
"Default init options to be passed to FSharpAutoComplete,
updated conditionally by `lsp-fsharp--make-init-options'.")
(defun lsp-fsharp--make-init-options ()
"Init options for F#."
(-let [opts lsp-fsharp--default-init-options]
(if lsp-fsharp-auto-workspace-init
(push '(:AutomaticWorkspaceInit . t) opts)
opts)))
(lsp-register-custom-settings
`(("FSharp.KeywordsAutocomplete" lsp-fsharp-keywords-autocomplete t)
("FSharp.ExternalAutocomplete" lsp-fsharp-external-autocomplete t)
("FSharp.Linter" lsp-fsharp-linter t)
("FSharp.UnionCaseStubGeneration" lsp-fsharp-union-case-stub-generation t)
("FSharp.UnionCaseStubGenerationBody" lsp-fsharp-union-case-stub-generation-body)
("FSharp.RecordStubGeneration" lsp-fsharp-record-stub-generation t)
("FSharp.RecordStubGenerationBody" lsp-fsharp-record-stub-generation-body)
("FSharp.InterfaceStubGeneration" lsp-fsharp-interface-stub-generation t)
("FSharp.InterfaceStubGenerationObjectIdentifier" lsp-fsharp-interface-stub-generation-object-identifier)
("FSharp.InterfaceStubGenerationMethodBody" lsp-fsharp-interface-stub-generation-method-body)
("FSharp.UnusedOpensAnalyzer" lsp-fsharp-unused-opens-analyzer t)
("FSharp.UnusedDeclarationsAnalyzer" lsp-fsharp-unused-declarations-analyzer t)
("FSharp.SimplifyNameAnalyzer" lsp-fsharp-simplify-name-analyzer t)
("FSharp.ResolveNamespaces" lsp-fsharp-resolve-namespaces t)
("FSharp.EnableReferenceCodeLens" lsp-fsharp-enable-reference-code-lens t)
("FSharp.GenerateBinlog" lsp-fsharp-generate-binlog t)))
(lsp-register-client
(make-lsp-client :new-connection (lsp-stdio-connection
#'lsp-fsharp--make-launch-cmd
#'lsp-fsharp--test-fsautocomplete-present)
:major-modes '(fsharp-mode)
:notification-handlers (ht ("fsharp/notifyCancel" #'ignore)
("fsharp/notifyWorkspace" #'ignore)
("fsharp/fileParsed" #'ignore)
("fsharp/notifyWorkspacePeek" #'ignore)
("fsharp/documentAnalyzed" #'ignore)
("fsharp/testDetected" #'ignore))
:initialization-options 'lsp-fsharp--make-init-options
:initialized-fn (lambda (workspace)
(with-lsp-workspace workspace
;; Something needs to be calling lsp--set-configuration
(progn
(lsp--set-configuration
(lsp-configuration-section "fsharp"))
(lsp-fsharp--workspace-load
(lsp-fsharp--project-list)))))
:after-open-fn ;; workaround https://github.com/fsharp/FsAutoComplete/issues/833
(lambda ()
(setq-local lsp-default-create-error-handler-fn
(lambda (method)
(lambda (error)
(when
(not
(seq-find (lambda (s)
(string= s (lsp-get error :message)))
'("Index was outside the bounds of the array."
"No symbol information found"
"No ident at this location")))
(lsp--warn
"%s"
(or (lsp--error-string error)
(format "%s Request has failed" method))))))))
:server-id 'fsac
:download-server-fn #'lsp-fsharp--fsac-install))
(lsp-consistency-check lsp-fsharp)
(provide 'lsp-fsharp)
;;; lsp-fsharp.el ends here
|
