-
Notifications
You must be signed in to change notification settings - Fork 34
/
lsp-metals.el
1006 lines (868 loc) · 41.8 KB
/
lsp-metals.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
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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; lsp-metals.el --- Scala Client settings -*- lexical-binding: t; -*-
;; Copyright (C) 2018-2019 Ross A. Baker <[email protected]>, Evgeny Kurnevsky <[email protected]>
;; Version: 1.0.0
;; Package-Requires: ((emacs "27.1") (scala-mode "0.23") (lsp-mode "7.0") (lsp-treemacs "0.2") (dap-mode "0.3") (dash "2.18.0") (f "0.20.0") (ht "2.0") (treemacs "3.1") (posframe "1.4.1"))
;; Author: Ross A. Baker <[email protected]>
;; Evgeny Kurnevsky <[email protected]>
;; Keywords: languages, extensions
;; URL: https://github.com/emacs-lsp/lsp-metals
;; 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-metals client
;;; Code:
(require 'lsp-mode)
(require 'dap-mode)
(require 'lsp-lens)
(require 'lsp-metals-protocol)
(require 'lsp-metals-treeview)
(require 'view)
(defgroup lsp-metals nil
"LSP support for Scala, using Metals."
:group 'lsp-mode
:link '(url-link "https://scalameta.org/metals")
:package-version '(lsp-metals . "1.0"))
(defcustom lsp-metals-server-command "metals"
"The command to launch the Scala language server."
:group 'lsp-metals
:type 'file
:package-version '(lsp-metals . "1.0"))
(defcustom lsp-metals-server-args '()
"Extra arguments for the Scala language server."
:group 'lsp-metals
:type '(repeat string)
:package-version '(lsp-metals . "1.0"))
(defcustom lsp-metals-server-install-dir
(f-join lsp-server-install-dir "metals/")
"Installation directory for Metals server."
:group 'lsp-metals
:type 'directory
:package-version '(lsp-metals . "1.2"))
(defcustom lsp-metals-coursier-store-path
(f-join lsp-metals-server-install-dir "coursier")
"The path where Coursier will be stored."
:group 'lsp-metals
:type 'file
:package-version '(lsp-metals . "1.2"))
(defcustom lsp-metals-metals-store-path
(f-join lsp-metals-server-install-dir "metals")
"The path where Metals will be stored."
:group 'lsp-metals
:type 'file
:package-version '(lsp-metals . "1.2"))
(defcustom lsp-metals-coursier-download-url
(pcase system-type
(`windows-nt "https://github.com/coursier/launchers/raw/master/cs-x86_64-pc-win32.zip")
(`darwin "https://github.com/coursier/launchers/raw/master/cs-x86_64-apple-darwin.gz")
(_ "https://github.com/coursier/launchers/raw/master/cs-x86_64-pc-linux.gz"))
"Download url for coursier."
:group 'lsp-metals
:type 'string
:package-version '(lsp-metals . "1.2"))
(defcustom lsp-metals-coursier-decompress
(pcase system-type
(`windows-nt :zip)
(_ :gzip))
"Compression type of the downloaded coursier binary."
:group 'lsp-metals
:type 'string
:package-version '(lsp-metals . "1.3"))
(defcustom lsp-metals-install-scala-version "2.13"
"Metals scala version to install."
:group 'lsp-metals
:type 'string
:package-version '(lsp-metals . "1.3"))
(defcustom lsp-metals-install-version "latest.release"
"Metals version to install."
:group 'lsp-metals
:type 'string
:package-version '(lsp-metals . "1.2"))
(defcustom lsp-metals-java-home ""
"The Java Home directory.
It's used for indexing JDK sources and locating the `java' binary."
:type '(string)
:group 'lsp-metals
:package-version '(lsp-metals . "1.0"))
(defcustom lsp-metals-scalafmt-config-path ""
"Optional custom path to the .scalafmt.conf file.
Should be an absolute path and use forward slashes / for file
separators (even on Windows)."
:type '(string)
:group 'lsp-metals
:package-version '(lsp-metals . "1.0"))
(defcustom lsp-metals-scalafix-config-path ""
"Optional custom path to the .scalafix.conf file.
Should be an absolute path and use forward slashes / for file
separators (even on Windows)."
:type '(string)
:group 'lsp-metals
:package-version '(lsp-metals . "1.0"))
(defcustom lsp-metals-sbt-script ""
"Optional absolute path to an `sbt' executable.
By default, Metals uses `java -jar sbt-launch.jar' with an embedded
launcher while respecting `.jvmopts' and `.sbtopts'. Update this
setting if your `sbt' script requires more customizations like using
environment variables."
:type '(string)
:group 'lsp-metals
:package-version '(lsp-metals . "1.0"))
(defcustom lsp-metals-gradle-script ""
"Optional absolute path to a `gradle' executable.
By default, Metals uses gradlew with 5.3.1 gradle version. Update
this setting if your `gradle' script requires more customizations like
using environment variables."
:type '(string)
:group 'lsp-metals
:package-version '(lsp-metals . "1.0"))
(defcustom lsp-metals-maven-script ""
"Optional absolute path to a `maven' executable.
By default, Metals uses mvnw maven wrapper with 3.6.1 maven version.
Update this setting if your `maven' script requires more
customizations."
:type '(string)
:group 'lsp-metals
:package-version '(lsp-metals . "1.0"))
(defcustom lsp-metals-mill-script ""
"Optional absolute path to a `mill' executable.
By default, Metals uses mill wrapper script with 0.5.0 mill version.
Update this setting if your mill script requires more customizations
like using environment variables."
:type '(string)
:group 'lsp-metals
:package-version '(lsp-metals . "1.0"))
(defcustom lsp-metals-pants-targets ""
"Space separated list of Pants targets to export.
For example, `src/main/scala:: src/main/java::'. Syntax such as
`src/{main,test}::' is not supported."
:type '(string)
:group 'lsp-metals
:package-version '(lsp-metals . "1.0"))
(make-obsolete-variable
'lsp-metals-pants-targets
"metals.pants-targets is no longer a valid configuration option, using it will have no effect."
"1.3")
(defcustom lsp-metals-bloop-sbt-already-installed nil
"If true, Metals will not generate a `project/metals.sbt' file.
This assumes that sbt-bloop is already manually installed in the sbt
build. Build import will fail with a `not valid command bloopInstall'
error in case Bloop is not manually installed in the build when using
this option."
:type 'boolean
:group 'lsp-metals
:package-version '(lsp-metals . "1.0"))
(defcustom lsp-metals-bloop-version nil
"The version of Bloop to use.
This version will be used for the Bloop build tool plugin, for any
supported build tool, while importing in Metals as well as for running
the embedded server."
:type '(choice
(const :tag "Default" nil)
(string :tag "Version"))
:group 'lsp-metals
:package-version '(lsp-metals . "1.0"))
(defcustom lsp-metals-super-method-lenses-enabled nil
"If True, super method lenses will be shown.
Super method lenses are visible above methods definition that override
another methods. Clicking on a lens jumps to super method definition.
Disabled lenses are not calculated for opened documents which might
speed up document processing."
:type 'boolean
:group 'lsp-metals
:package-version '(lsp-metals . "1.0"))
(defcustom lsp-metals-show-implicit-arguments nil
"If True, implicit argument annotations will be shown.
When this option is enabled, each method that has implicit arguments has them
displayed either as additional decorations."
:type 'boolean
:group 'lsp-metals
:package-version '(lsp-metals . "1.2"))
(defcustom lsp-metals-show-implicit-conversions-and-classes nil
"If True, implicit conversions and classes will be shown.
When this option is enabled, each place where an implicit method or class is
used has it displayed either as additional decorations."
:type 'boolean
:group 'lsp-metals
:package-version '(lsp-metals . "1.2"))
(defcustom lsp-metals-show-inferred-type nil
"If True, inferred type annotations will be shown.
When this option is enabled, each method that can have inferred types has them
displayed either as additional decorations."
:type 'boolean
:group 'lsp-metals
:package-version '(lsp-metals . "1.2"))
(defcustom lsp-metals-ammonite-jvm-properties nil
"Optional vector of JVM properties to pass along to the Ammonite server.
Each property needs to be a separate item.
Example: -Xmx1G or -Xms100M."
:type '(lsp-repeatable-vector string)
:group 'lsp-metals
:package-version '(lsp-metals . "1.3"))
(defcustom lsp-metals-enable-indent-on-paste nil
"Indent snippets when pasted.
When this option is enabled, when a snippet is pasted into a Scala file,
Metals will try to adjust the indentation to that of the current cursor."
:type 'boolean
:group 'lsp-metals
:package-version '(lsp-metals . "1.3"))
(defcustom lsp-metals-fallback-scala-version "3.2.0"
"The Scala compiler version that is used as the default or fallback.
Used when a file doesn't belong to any build target or the specified Scala
version isn't supported by Metals. This applies to standalone Scala files,
worksheets, and Ammonite scripts."
:type 'string
:group 'lsp-metals
:package-version '(lsp-metals . "1.3"))
(defcustom lsp-metals-test-user-interface "Code Lenses"
"Default way of handling tests and test suites."
:type 'string
:group 'lsp-metals
:package-version '(lsp-metals . "1.3"))
(defcustom lsp-metals-java-format.eclipse-config-path ""
"Optional custom path to the eclipse-formatter.xml file.
Should be an absolute path and use forward slashes / for file separators (even
on Windows)."
:type 'string
:group 'lsp-metals
:package-version '(lsp-metals . "1.3"))
(defcustom lsp-metals-java-format.eclipse-profile ""
"The eclipse profile name.
If the Eclipse formatter file contains more than one profile, this option can be
used to control which is used."
:type 'string
:group 'lsp-metals
:package-version '(lsp-metals . "1.3"))
(defcustom lsp-metals-scala-cli-launcher ""
"Optional absolute path to a scala-cli executable.
The executable will be used for running a Scala CLI BSP server. By default,
Metals uses the scala-cli from the PATH, or if it's not found, downloads and
runs Scala CLI on the JVM (slower than native Scala CLI). Update this if you
want to use a custom Scala CLI launcher, not available in PATH."
:type 'string
:group 'lsp-metals
:package-version '(lsp-metals . "1.3"))
(defcustom lsp-metals-enable-semantic-highlighting nil
"Use semantic tokens highlight.
When this option is enabled, Metals will provide semantic tokens for clients
that support it. The feature is still experimental and does not work for all
sources."
:type 'boolean
:group 'lsp-metals
:package-version '(lsp-metals . "1.3"))
(defcustom lsp-metals-remote-language-server ""
"A URL pointing to a remote language server."
:type '(string)
:group 'lsp-metals
:package-version '(lsp-metals . "1.0"))
(defcustom lsp-metals-slow-task-frame-border-width 1
"Border width of the slow task frame."
:group 'lsp-metals
:type 'natnum
:package-version '(lsp-metals . "1.3"))
(defcustom lsp-metals-slow-task-frame-border-color "white"
"Border color of the slow task frame."
:group 'lsp-metals
:type 'string
:package-version '(lsp-metals . "1.3"))
(defcustom lsp-metals-multi-root t
"If non nil, `metals' will be started in multi-root mode."
:type 'boolean
:group 'lsp-metals
:package-version '(lsp-metals . "1.3"))
(defface lsp-metals-face-overlay
'((t :inherit font-lock-comment-face))
"Face used for metals decoration overlays."
:group 'lsp-metals)
(defconst lsp-metals--javap-format-id "javap")
(defconst lsp-metals--javap-verbose-format-id "javap-verbose")
(defconst lsp-metals--semanticdb-compact-format-id "semanticdb-compact")
(defconst lsp-metals--semanticdb-detailed-format-id "semanticdb-detailed")
(defconst lsp-metals--tasty-decoded-format-id "tasty-decoded")
(defconst lsp-metals--all-format-ids (list lsp-metals--javap-format-id
lsp-metals--javap-verbose-format-id
lsp-metals--semanticdb-compact-format-id
lsp-metals--semanticdb-detailed-format-id
lsp-metals--tasty-decoded-format-id))
(lsp-register-custom-settings
'(("metals.java-home" lsp-metals-java-home)
("metals.sbt-script" lsp-metals-sbt-script)
("metals.gradle-script" lsp-metals-gradle-script)
("metals.maven-script" lsp-metals-maven-script)
("metals.mill-script" lsp-metals-mill-script)
("metals.scalafmt-config-path" lsp-metals-scalafmt-config-path)
("metals.scalafix-config-path" lsp-metals-scalafix-config-path)
("metals.ammonite-jvm-properties" lsp-metals-ammonite-jvm-properties)
("metals.bloop-sbt-already-installed" lsp-metals-bloop-sbt-already-installed t)
("metals.bloop-version" lsp-metals-bloop-version)
("metals.super-method-lenses-enabled" lsp-metals-super-method-lenses-enabled t)
("metals.show-inferred-type" lsp-metals-show-inferred-type t)
("metals.show-implicit-arguments" lsp-metals-show-implicit-arguments t)
("metals.show-implicit-conversions-and-classes" lsp-metals-show-implicit-conversions-and-classes t)
("metals.enable-indent-on-paste" lsp-metals-enable-indent-on-paste t)
("metals.remote-language-server" lsp-metals-remote-language-server)
("metals.fallback-scala-version" lsp-metals-fallback-scala-version)
("metals.test-user-interface" lsp-metals-test-user-interface)
("metals.java-format.eclipse-config-path" lsp-metals-java-format.eclipse-config-path)
("metals.java-format.eclipse-profile" lsp-metals-java-format.eclipse-profile)
("metals.scala-cli-launcher" lsp-metals-scala-cli-launcher)
("metals.enable-semantic-highlighting" lsp-metals-enable-semantic-highlighting t)))
(lsp-dependency
'coursier
'(:system "cs")
'(:system "coursier")
`(:download :url ,lsp-metals-coursier-download-url
:store-path ,lsp-metals-coursier-store-path
:decompress ,lsp-metals-coursier-decompress
:set-executable? t))
(lsp-dependency
'metals
`(:system ,lsp-metals-server-command)
`(:system ,lsp-metals-metals-store-path))
(defun lsp-metals--server-command ()
"Generate the Scala language server startup command."
`(,(lsp-package-path 'metals) ,@lsp-metals-server-args))
(defun lsp-metals--download-server (_client callback error-callback _update?)
"Install metals server via coursier.
Will invoke CALLBACK on success, ERROR-CALLBACK on error."
(lsp-package-ensure
'coursier
(lambda ()
(call-process
(lsp-package-path 'coursier)
nil
(get-buffer-create "*Coursier log*")
t
"bootstrap"
"--java-opt"
"-Xss4m"
"--java-opt"
"-Xms100m"
(concat "org.scalameta:metals_" lsp-metals-install-scala-version ":" lsp-metals-install-version)
"-r"
"bintray:scalacenter/releases"
"-r"
"sonatype:snapshots"
"-o"
lsp-metals-metals-store-path
"-f")
(funcall callback))
error-callback))
(defun lsp-metals-build-import ()
"Unconditionally run `sbt bloopInstall` and re-connect to the build server."
(interactive)
(lsp-metals-treeview--send-execute-command-async "build-import" ()))
(defun lsp-metals-build-connect ()
"Unconditionally cancel existing build server connection and re-connect."
(interactive)
(lsp-metals-treeview--send-execute-command-async "build-connect" ()))
(defun lsp-metals-cancel-compilation ()
"Cancel the currently ongoing compilation, if any."
(interactive)
(lsp-metals-treeview--send-execute-command-async "compile-cancel" ()))
(defun lsp-metals-cascade-compile ()
"Cascade compile all open files."
(interactive)
(lsp-metals-treeview--send-execute-command-async "compile-cascade"))
(defun lsp-metals-clean-compile ()
"Recompile all build targets in this workspace."
(interactive)
(lsp-metals-treeview--send-execute-command-async "compile-clean"))
(defun lsp-metals-restart-build-server ()
"Unconditionally stop the current running Bloop server and start a new one."
(interactive)
(lsp-metals-treeview--send-execute-command-async "build-restart"))
(defun lsp-metals-new-scala-file ()
"Create a new file either a class, object, trait, package object or worksheet."
(interactive)
(lsp--send-execute-command "new-scala-file" (concat "file://" default-directory)))
(defun lsp-metals-new-scala-project ()
"Create a new Scala project using one of the available g8 templates."
(interactive)
(lsp--send-execute-command "new-scala-project"))
(defun lsp-metals-doctor-run ()
"Open the Metals doctor to troubleshoot potential build problems."
(interactive)
(lsp-send-execute-command "doctor-run" ()))
(defun lsp-metals-sources-scan ()
"Walk all files in the workspace and index where symbols are defined."
(interactive)
(lsp-metals-treeview--send-execute-command-async "sources-scan" ()))
(defun lsp-metals-reset-choice ()
"Reset a decision you made about different settings.
E.g. If you choose to import workspace with sbt you can decide to reset and
change it again."
(interactive)
(lsp-send-execute-command "reset-choice" ()))
(defun lsp-metals-copy-worksheet-output ()
"Copy worksheet with evaluated results as comments."
(interactive)
(let ((command-result (lsp-send-execute-command "metals.copy-worksheet-output" (lsp--buffer-uri))))
(when-let ((value (lsp-get command-result :value)))
(kill-new value)
(message "Copied worksheet output."))))
(defun lsp-metals-analyze-stacktrace ()
"Convert provided stacktrace in the region to a format with links."
(interactive)
(when (and (use-region-p) default-directory)
(with-lsp-workspace (lsp-find-workspace 'metals default-directory)
(let ((stacktrace (buffer-substring (region-beginning) (region-end))))
(lsp-send-execute-command "metals.analyze-stacktrace" (vector stacktrace))))))
(defun lsp-metals-super-method-hierarchy ()
"Calculate inheritance hierarchy of a class that should contain given method."
(interactive)
(lsp-send-execute-command
"super-method-hierarchy"
(lsp--text-document-position-params)))
(defun lsp-metals-goto-super-method ()
"Jumps to super method/field definition of a symbol under cursor."
(interactive)
(lsp-send-execute-command
"goto-super-method"
(lsp--text-document-position-params)))
(defun lsp-metals--generate-decode-file-buffer-name (uri)
"Generate DecodeFile buffer name for the given URI."
(format "*%s*" (file-name-nondirectory uri)))
(defun lsp-metals--decode (uri)
"View the decoded representation of the given URI."
(when-let* ((command-result (lsp-send-execute-command "metals.file-decode" uri))
(value (lsp-get command-result :value)))
(pop-to-buffer (lsp-metals--generate-decode-file-buffer-name uri))
(setq-local show-trailing-whitespace nil)
(setq-local buffer-read-only nil)
(erase-buffer)
(insert value)
(goto-char (point-min))
(when (string-suffix-p "javap" uri)
(require 'cc-mode)
(java-mode)
(insert "// "))
(view-mode 1)
(setq view-exit-action 'kill-buffer)))
(defun lsp-metals-decode-file (format-id)
"View the decoded representation of the given FORMAT-ID for the current buffer.
When run as a command, prompt for the format id to use from
`lsp-metals--all-format-ids'. See URL
`https://scalameta.org/metals/docs/integrations/new-editor/#decode-file'
for more information on the metals \"files-decode\" command."
(interactive (list (completing-read "format: " lsp-metals--all-format-ids)))
(lsp-metals--decode (format "metalsDecode:%s.%s" (lsp--buffer-uri) format-id)))
(defun lsp-metals-view-javap ()
"View javap for a class in the current file."
(interactive)
(lsp-metals-decode-file lsp-metals--javap-format-id))
(defun lsp-metals-view-javap-verbose ()
"View javap verbose a class in the for current file."
(interactive)
(lsp-metals-decode-file lsp-metals--javap-verbose-format-id))
(defun lsp-metals-view-semanticdb-compact ()
"View semanticdb compact for current file."
(interactive)
(lsp-metals-decode-file lsp-metals--semanticdb-compact-format-id))
(defun lsp-metals-view-semanticdb-detailed ()
"View semanticdb detailed for current file."
(interactive)
(lsp-metals-decode-file lsp-metals--semanticdb-detailed-format-id))
(defun lsp-metals-view-tasty-decoded ()
"View tasty decoded for current file."
(interactive)
(lsp-metals-decode-file lsp-metals--tasty-decoded-format-id))
(defun lsp-metals-run-scalafix ()
"Run scalafix rules for the current buffer, requires metals >= v0.11.7."
(interactive)
(lsp-send-execute-command "scalafix-run" (lsp--text-document-position-params)))
(defun lsp-metals--browse-url (url &rest _)
"Handle `command:' matals URLs."
(when-let* ((workspace (lsp-find-workspace 'metals default-directory))
(decoded (url-unhex-string url))
((string-match "command:\\(.*\\)\\?\\(.*\\)" decoded))
(command (match-string 1 decoded))
(arguments (lsp--read-json (match-string 2 decoded))))
(lsp-metals--execute-client-command workspace (lsp-make-execute-command-params :command command :arguments? arguments))))
(defun lsp-metals--render-html (html)
"Render the Metals HTML in the current buffer."
(require 'shr)
(setq-local show-trailing-whitespace nil)
(setq-local buffer-read-only nil)
(setq-local browse-url-handlers '(("\\`command:" . lsp-metals--browse-url)))
(erase-buffer)
(insert html)
(shr-render-region (point-min) (point-max))
(goto-char (point-min))
(view-mode 1)
(setq view-exit-action 'kill-buffer))
(defun lsp-metals--generate-doctor-buffer-name (workspace)
"Generate doctor buffer name for the WORKSPACE."
(format "*Metals Doctor: %s*" (process-id (lsp--workspace-cmd-proc workspace))))
(defun lsp-metals--doctor-run (workspace &optional html?)
"Focus on a window displaying troubleshooting help from the Metals doctor.
HTML is the help contents.
WORKSPACE is the workspace the client command was received from."
(if (not html?)
(lsp-send-execute-command "doctor-run" ())
(pop-to-buffer (lsp-metals--generate-doctor-buffer-name workspace))
(lsp-metals--render-html html?)))
(defun lsp-metals--doctor-reload (workspace html)
"Reload the HTML contents of an open Doctor window, if any.
Should be ignored if there is no open doctor window.
WORKSPACE is the workspace the client command was received from."
(when-let ((buffer (get-buffer (lsp-metals--generate-doctor-buffer-name workspace))))
(with-current-buffer buffer
(lsp-metals--render-html html))))
(defun lsp-metals--goto-location (workspace location &optional _)
"Move the cursor focus to the provided LOCATION.
WORKSPACE is the workspace the client command was received from."
(let ((uri (url-unhex-string (lsp--location-uri location))))
(if (string-prefix-p "metalsDecode:" uri)
(with-lsp-workspace workspace (lsp-metals--decode uri))
(let ((xrefs (lsp--locations-to-xref-items (list location))))
(if (boundp 'xref-show-definitions-function)
(with-no-warnings
(funcall xref-show-definitions-function
(-const xrefs)
`((window . ,(selected-window)))))
(xref--show-xrefs xrefs nil))))))
(defun lsp-metals--echo-command (workspace command)
"A client COMMAND that should be forwarded back to the Metals server.
WORKSPACE is the workspace the client command was received from."
(with-lsp-workspace workspace
(lsp-send-execute-command command)))
(defun lsp-metals-bsp-switch ()
"Interactively switch between BSP servers."
(interactive)
(lsp-send-execute-command "bsp-switch" ()))
(defun lsp-metals-generate-bsp-config ()
"Generate a Scala BSP Config based on the current BSP server."
(interactive)
(lsp-send-execute-command "generate-bsp-config" ()))
(defun lsp-metals-zip-reports ()
"Create a zip from incognito and bloop reports."
(interactive)
(lsp-send-execute-command "zip-reports" ()))
(defun lsp-metals-reset-workspace ()
"Clean metals cache and restart build server."
(interactive)
(lsp-send-execute-command "reset-workspace" ()))
(defun lsp-metals-open-server-log ()
"Open a buffer with the metals log for the current workspace."
(interactive)
(if-let ((root (lsp-workspace-root)))
(if-let* ((log-file (f-join (file-name-as-directory root) ".metals" "metals.log"))
((f-exists-p log-file)))
(progn (find-file log-file) (goto-char (point-max)))
(user-error "%s does not exist, are you in the right directory?" log-file))
(user-error "No LSP workspace is in effect")))
(lsp-defun lsp-metals--publish-decorations (workspace (&PublishDecorationsParams :uri :options))
"Handle the metals/publishDecorations extension notification.
WORKSPACE is the workspace the notification was received from."
(with-lsp-workspace workspace
(let* ((file (lsp--uri-to-path uri))
(buffer (find-buffer-visiting file)))
(when buffer
(with-current-buffer buffer
(lsp--remove-overlays 'metals-decoration)
(mapc #'lsp-metals--make-overlay options))))))
(lsp-defun lsp-metals--make-overlay ((&DecorationOptions :range :render-options :hover-message?))
"Create overlay from metals decoration."
(let* ((region (lsp--range-to-region range))
(ov (make-overlay (car region) (cdr region) nil t t)))
(-when-let* (((&ThemableDecorationInstanceRenderOption :after?) render-options)
((&ThemableDecorationAttachmentRenderOptions :content-text?) after?)
(text (if hover-message?
(propertize content-text? 'help-echo (lsp--render-element hover-message?))
content-text?)))
(overlay-put ov 'after-string (propertize text 'cursor t 'font-lock-face 'lsp-metals-face-overlay)))
(overlay-put ov 'metals-decoration t)))
(defun lsp-metals--logs-toggle (_workspace)
"Toggle focus on the logs reported by the server via `window/logMessage'."
(switch-to-buffer (get-buffer-create "*lsp-log*")))
(defun lsp-metals--diagnostics-focus (_workspace)
"Focus on the window that lists all published diagnostics."
(lsp-treemacs-errors-list))
(defun lsp-metals--show-stacktrace (_workspace html)
"Display stacktrace in a new buffer.
HTML is the stacktrace contents."
(pop-to-buffer (generate-new-buffer "*Metals Stacktrace*"))
(lsp-metals--render-html html))
(defun lsp-metals--reset-choice (workspace &optional choice?)
"Reset a decision you made about different settings.
WORKSPACE is the workspace the notification was received from.
CHOICE is the decision to reset."
(with-lsp-workspace workspace (lsp-send-execute-command "reset-choice" choice?)))
(lsp-defun lsp-metals--execute-client-command (workspace (&ExecuteCommandParams :command :arguments?))
"Handle the metals/executeClientCommand extension notification.
WORKSPACE is the workspace the notification was received from."
(when-let ((command (pcase (string-remove-prefix "metals." command)
(`"metals-doctor-run" #'lsp-metals--doctor-run)
(`"metals-doctor-reload" #'lsp-metals--doctor-reload)
(`"metals-logs-toggle" #'lsp-metals--logs-toggle)
(`"metals-diagnostics-focus" #'lsp-metals--diagnostics-focus)
(`"metals-goto-location" #'lsp-metals--goto-location)
(`"metals-echo-command" #'lsp-metals--echo-command)
(`"metals-model-refresh" #'lsp-metals--model-refresh)
(`"metals-show-stacktrace" #'lsp-metals--show-stacktrace)
(`"reset-choice" #'lsp-metals--reset-choice)
(c (ignore (lsp-warn "Unknown metals client command: %s" c))))))
(apply command (append (list workspace) arguments? nil))))
(defvar lsp-metals--current-buffer nil
"Current buffer used to send `metals/didFocusTextDocument' notification.")
(defun lsp-metals--window-state-did-change (focused)
"Send `metals/windowStateDidChange' notification on frames focus change.
FOCUSED if there is a focused frame."
(lsp-notify "metals/windowStateDidChange" `((focused . ,focused))))
(defun lsp-metals--workspaces ()
"Get the list of all metals workspaces."
(--filter
(eq (lsp--client-server-id (lsp--workspace-client it)) 'metals)
(lsp--session-workspaces (lsp-session))))
(defmacro lsp-metals--add-focus-hooks ()
"Add hooks for `metals/windowStateDidChange' notification."
(if (boundp 'after-focus-change-function)
`(progn
(defun lsp-metals--handle-focus-change ()
"Send `metals/windowStateDidChange' notification on frames focus change."
(let ((focused (if (and (fboundp 'frame-focus-state) (frame-focus-state)) t :json-false)))
(--each (lsp-metals--workspaces)
(with-lsp-workspace it
(lsp-metals--window-state-did-change focused)))))
(add-function :after after-focus-change-function 'lsp-metals--handle-focus-change))
`(progn
(defun lsp-metals--focus-in-hook ()
"Send `metals/windowStateDidChange' notification when a frame gains focus."
(--each (lsp-metals--workspaces)
(with-lsp-workspace it
(lsp-metals--window-state-did-change t))))
(add-hook 'focus-in-hook 'lsp-metals--focus-in-hook)
(defun lsp-metals--focus-out-hook ()
"Send `metals/windowStateDidChange' notification when all frames lost focus."
(--each (lsp-metals--workspaces)
(with-lsp-workspace it
(lsp-metals--window-state-did-change :json-false))))
(add-hook 'focus-out-hook 'lsp-metals--focus-out-hook))))
(defun lsp-metals--did-focus ()
"Send `metals/didFocusTextDocument' on buffer switch."
(unless (eq lsp-metals--current-buffer (current-buffer))
(setq lsp-metals--current-buffer (current-buffer))
(lsp-notify "metals/didFocusTextDocument" (lsp--buffer-uri))))
(defun lsp-metals-populate-config (conf)
"Prepare CONF for debug session."
(if (and (plist-get conf :debugServer)
(plist-get conf :name))
conf
(-let (((&DebugSession :name :uri)
(lsp-send-execute-command
"debug-adapter-start"
(vector (list :data conf
:dataKind (cond
((equal "attach" (plist-get conf :request))
"scala-attach-remote")
((plist-get conf :dataKind))
(t "scala-main-class"))
:targets (or
(plist-get conf :targets)
(vector `(:uri ,(concat
(lsp--path-to-uri (or (lsp-workspace-root)
(error "The debug provide can be called under project root")))
"?id="
(or
(plist-get conf :buildTarget)
"root"))))))))))
(-> conf
(dap--put-if-absent :name name)
(dap--put-if-absent :request "launch")
(dap--put-if-absent :host (or "localhost"
(plist-get conf :hostName)))
(dap--put-if-absent :debugServer
(-> uri
(split-string ":")
cl-third
string-to-number))))))
(dap-register-debug-provider "scala" #'lsp-metals-populate-config)
(dap-register-debug-template
"Scala Main Class"
'(:type "scala" :class "<main.class>" :name "Scala Main Class" :arguments [] :jvmOptions [] :environmentVariables []))
(dap-register-debug-template
"Scala Attach"
'(:type "scala" :request "attach" :name "Scala Attach" :hostName "localhost" :port 0))
(lsp-defun lsp-metals--debug-start (no-debug (&Command :arguments?))
"Start debug session.
If NO-DEBUG is true launch the program without enabling debugging.
PARAMS are the action params."
;; make sure the arguments are plist
(-let (((&DebugSession :name :uri) (lsp-send-execute-command
"debug-adapter-start"
arguments?)))
(dap-debug
(list :debugServer (-> uri
(split-string ":")
cl-third
string-to-number)
:type "scala"
:name name
:host "localhost"
:request "launch"
:noDebug no-debug))))
(defun lsp-metals--model-refresh (workspace)
"Handle `metals-model-refresh' notification refreshing lenses.
WORKSPACE is the workspace the notification was received from."
(->> workspace
(lsp--workspace-buffers)
(mapc (lambda (buffer)
(with-current-buffer buffer
(when (bound-and-true-p lsp-lens-mode)
(lsp-lens--schedule-refresh t)))))))
(defun lsp-metals--status-string-keymap (workspace command?)
"Keymap for `metals/status' notification.
WORKSPACE is the workspace we received notification from.
COMMAND is the client command to execute."
(when command?
(-doto (make-sparse-keymap)
(define-key [mode-line mouse-1]
(lambda ()
(interactive)
(lsp-metals--execute-client-command workspace (lsp-make-execute-command-params :command command?)))))))
(lsp-defun lsp-metals--status-string (workspace (&MetalsStatusParams :text :hide? :tooltip? :command?))
"Handle `metals/status' notification.
WORKSPACE is the workspace we received notification from."
(if (or hide? (s-blank-str? text))
(lsp-workspace-status nil workspace)
(lsp-workspace-status (propertize text
'help-echo tooltip?
'local-map (lsp-metals--status-string-keymap workspace command?))
workspace)))
(lsp-defun lsp-metals--quick-pick (_workspace (&MetalsQuickPickParams :items :place-holder?))
"Provide a string value by picking from given options."
(let* ((choices (--map (-let* (((&MetalsQuickPickItem :id :label :description?) it))
(cons label (cons id description?)))
items)))
(if choices
(let ((completion-extra-properties
`(:annotation-function (lambda (c)
(-when-let (description (cdr (cdr (assoc c ',choices))))
(concat " " description))))))
(list :itemId (car (cdr (assoc (completing-read (concat place-holder? ": ") choices nil t) choices))))))))
(lsp-defun lsp-metals--input-box (_workspace (&MetalsInputBoxParams :prompt))
"Provide a string value for a given prompt."
(list :value (read-from-minibuffer (concat prompt ": "))))
(defun lsp-metals--slow-task-buffer-name (workspace)
"Generate slow task buffer name for the WORKSPACE."
(format " *Metals Slow Task: %s*" (process-id (lsp--workspace-cmd-proc workspace))))
(defun lsp-metals--slow-task-press (workspace callback cancel _)
"CANCEL slow task or close its frame in the WORKSPACE using CALLBACK."
(funcall callback (list :cancel (or cancel :json-false)))
(posframe-hide (lsp-metals--slow-task-buffer-name workspace)))
;; Copied from button.el, should be replaced by native `button-buttonize'
;; when we drop support for emacs 26 and 27.
(defun lsp-metals--button-buttonize (string callback &optional data)
"Make STRING into a button and return it.
When clicked, CALLBACK will be called with the DATA as the
function argument. If DATA isn't present (or is nil), the button
itself will be used instead as the function argument."
(propertize string
'face 'button
'button t
'follow-link t
'category t
'button-data data
'keymap button-map
'action callback))
(defun lsp-metals--slow-task-text (workspace message callback)
"Generate a buffer text for slow task with MESSAGE.
CALLBACK is a function that sends user action to metals.
WORKSPACE is the workspace we received notification from."
(let* ((text (format "Metals: %s" message))
(button (lambda (text cancel)
(lsp-metals--button-buttonize (propertize text 'pointer 'hand)
(-partial #'lsp-metals--slow-task-press workspace callback cancel))))
(cancel (funcall button "cancel" t))
(close (funcall button "close" nil)))
(concat text
"\n"
cancel
(make-string (max 1 (- (string-width text) (string-width cancel) (string-width close))) ?\s)
close)))
(lsp-defun lsp-metals--slow-task (workspace (&MetalsSlowTaskParams :message) callback)
"Handle the metals/slowTask extension notification."
(when (posframe-workable-p)
(posframe-show (lsp-metals--slow-task-buffer-name workspace)
:string (lsp-metals--slow-task-text workspace message callback)
:poshandler 'posframe-poshandler-frame-bottom-right-corner
:border-width lsp-metals-slow-task-frame-border-width
:border-color lsp-metals-slow-task-frame-border-color)))
(defun lsp-metals--cancel-request (workspace _)
"Cancel request that indicates that the slow task has completed.
WORKSPACE is the workspace the client command was received from."
(when (posframe-workable-p)
(posframe-hide (lsp-metals--slow-task-buffer-name workspace))))
(defun lsp-metals--on-workspace-shutdown (workspace)
"Delete slow task posframe pertaining to the WORKSPACE."
(when (posframe-workable-p)
(posframe-delete (lsp-metals--slow-task-buffer-name workspace))))
(add-hook 'lsp-after-uninitialized-functions #'lsp-metals--on-workspace-shutdown)
(lsp-register-client
(make-lsp-client :new-connection (lsp-stdio-connection 'lsp-metals--server-command)
:major-modes '(scala-mode scala-ts-mode)
:priority -1
:multi-root lsp-metals-multi-root
:initialization-options '((decorationProvider . t)
(inlineDecorationProvider . t)
(didFocusProvider . t)
(executeClientCommandProvider . t)
(doctorProvider . "html")
(statusBarProvider . "on")
(slowTaskProvider . t)
(debuggingProvider . t)
(treeViewProvider . t)
(quickPickProvider . t)
(inputBoxProvider . t)
(commandInHtmlFormat . "vscode"))
:notification-handlers (ht ("metals/executeClientCommand" #'lsp-metals--execute-client-command)
("metals/publishDecorations" #'lsp-metals--publish-decorations)
("metals/treeViewDidChange" #'lsp-metals-treeview--did-change)
("metals-model-refresh" #'lsp-metals--model-refresh)
("metals/status" #'lsp-metals--status-string)
("$/cancelRequest" #'lsp-metals--cancel-request))
:request-handlers (ht ("metals/quickPick" #'lsp-metals--quick-pick)
("metals/inputBox" #'lsp-metals--input-box))
:async-request-handlers (ht ("metals/slowTask" #'lsp-metals--slow-task))
:action-handlers (ht ("metals-debug-session-start" (-partial #'lsp-metals--debug-start :json-false))
("metals-run-session-start" (-partial #'lsp-metals--debug-start t)))
:server-id 'metals
:initialized-fn (lambda (workspace)
(lsp-metals--add-focus-hooks)
(with-lsp-workspace workspace
(lsp--set-configuration
(lsp-configuration-section "metals"))))
:after-open-fn (lambda ()
(add-hook 'lsp-on-idle-hook #'lsp-metals--did-focus nil t))
:completion-in-comments? t
:download-server-fn #'lsp-metals--download-server))
(defmacro lsp-metals--create-bool-toggle (name config var)
"Create a toggle for lsp-metal config.
NAME is a user-facing name used for the interactive command. CONFIG is the LSP
configuration name. VAR is the variable holding the value of the configuration."
(let ((func-name (intern (format "lsp-metals-toggle-%s" name))))
`(defun ,func-name ()
,(format "Toggle LSP metals %s config" name)
(interactive)
(setq ,var (not ,var))
(lsp-register-custom-settings '((,(format "metals.%s" config) ,var t)))
(with-lsp-workspaces (lsp-metals--workspaces)
(lsp--set-configuration (lsp-configuration-section "metals")))
(let ((status (if ,var "on" "off")))
(lsp--info "Turned %s %s" status ,name)))))
(lsp-metals--create-bool-toggle "show-inferred-type" "show-inferred-type" lsp-metals-show-inferred-type)
(lsp-metals--create-bool-toggle "show-implicit-arguments" "show-implicit-arguments" lsp-metals-show-implicit-arguments)
(lsp-metals--create-bool-toggle "show-super-method-lenses" "super-method-lenses-enabled" lsp-metals-super-method-lenses-enabled)
(lsp-metals--create-bool-toggle "show-implicit-conversions" "show-implicit-conversions-and-classes" lsp-metals-show-implicit-conversions-and-classes)
(lsp-metals--create-bool-toggle "enable-semantic-highlighting" "enable-semantic-highlighting" lsp-metals-enable-semantic-highlighting)