-
-
Notifications
You must be signed in to change notification settings - Fork 909
/
Copy pathlsp-javascript.el
1066 lines (922 loc) · 48 KB
/
lsp-javascript.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-javascript.el --- description -*- lexical-binding: t; -*-
;; Copyright (C) 2020 emacs-lsp maintainers
;; Author: emacs-lsp maintainers
;; Keywords: lsp,
;; 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 Clients for the JavaScript and TypeScript Programming Languages.
;;; Code:
(require 'lsp-mode)
(lsp-dependency 'javascript-typescript-langserver
'(:system "javascript-typescript-stdio")
'(:npm :package "javascript-typescript-langserver"
:path "javascript-typescript-stdio"))
(defgroup lsp-typescript-javascript nil
"Support for TypeScript/JavaScript, using Sourcegraph's JavaScript/TypeScript language server."
:group 'lsp-mode
:link '(url-link "https://github.com/sourcegraph/javascript-typescript-langserver"))
;; Original name can be confused with initializationOptions. Preferences is just one option of initializationOptions.
(define-obsolete-variable-alias
'lsp-clients-typescript-init-opts
'lsp-clients-typescript-preferences
"lsp-mode 9.0.0")
(defcustom lsp-clients-typescript-javascript-server-args '()
"Extra arguments for the typescript-language-server language server."
:group 'lsp-typescript-javascript
:risky t
:type '(repeat string))
(defun lsp-typescript-javascript-tsx-jsx-activate-p (filename &optional _)
"Check if the js-ts lsp server should be enabled based on FILENAME."
(or (string-match-p "\\.[cm]js\\|\\.[jt]sx?\\'" filename)
(and (derived-mode-p 'js-mode 'js-ts-mode 'typescript-mode 'typescript-ts-mode)
(not (derived-mode-p 'json-mode)))))
;; Unmaintained sourcegraph server
(lsp-register-client
(make-lsp-client :new-connection (lsp-stdio-connection (lambda ()
(cons (lsp-package-path 'javascript-typescript-langserver)
lsp-clients-typescript-javascript-server-args)))
:activation-fn 'lsp-typescript-javascript-tsx-jsx-activate-p
:priority -3
:completion-in-comments? t
:server-id 'jsts-ls
:download-server-fn (lambda (_client callback error-callback _update?)
(lsp-package-ensure
'javascript-typescript-langserver
callback
error-callback))
:initialized-fn (lambda (_workspace)
(warn (concat "The javascript-typescript-langserver (jsts-ls) is unmaintained; "
"it is recommended to use ts-ls or deno-ls instead.")))))
(defgroup lsp-typescript nil
"LSP support for TypeScript, using Theia/Typefox's TypeScript Language Server."
:group 'lsp-mode
:link '(url-link "https://github.com/theia-ide/typescript-language-server"))
(defcustom lsp-clients-typescript-tls-path "typescript-language-server"
"Path to the typescript-language-server binary."
:group 'lsp-typescript
:risky t
:type 'string)
(defcustom lsp-clients-typescript-server-args '("--stdio")
"Extra arguments for the typescript-language-server language server."
:group 'lsp-typescript
:risky t
:type '(repeat string))
(defcustom lsp-clients-typescript-disable-automatic-typing-acquisition nil
"Disable tsserver from automatically fetching missing type definitions.
\(@types packages) for external modules."
:group 'lsp-typescript
:type 'boolean)
(defcustom lsp-clients-typescript-log-verbosity "info"
"The verbosity level of the information printed in the log by tsserver."
:group 'lsp-typescript
:type '(choice
(const "off")
(const "terse")
(const "normal")
(const "requesttime")
(const "verbose")))
(defcustom lsp-clients-typescript-max-ts-server-memory nil
"The maximum size of the V8's old memory section in megabytes.
\(for example 4096 means 4GB). The default value is dynamically configured
by Node so can differ per system. Increase for very big projects that
exceed allowed memory usage."
:group 'lsp-typescript
:type 'integer)
(defcustom lsp-clients-typescript-npm-location nil
"Specifies the path to the NPM exec used for Automatic Type Acquisition."
:group 'lsp-typescript
:type 'string)
(defcustom lsp-clients-typescript-prefer-use-project-ts-server nil
"When set, prefers using the tsserver.js from your project. This
can allow loading plugins configured in your tsconfig.json."
:group 'lsp-typescript
:type 'boolean)
(defcustom lsp-clients-typescript-plugins (vector)
"The list of plugins to load.
It should be a vector of plist with keys `:location' and `:name'
where `:name' is the name of the package and `:location' is the
directory containing the package. Example:
\(vector
\(list :name \"@vsintellicode/typescript-intellicode-plugin\"
:location \"<path>.vscode/extensions/visualstudioexptteam.
vscodeintellicode-1.1.9/\"))"
:group 'lsp-typescript
:type '(restricted-sexp :tag "Vector"
:match-alternatives
(lambda (xs)
(and (vectorp xs) (seq-every-p
(-lambda ((&plist :name :location))
(and name location))
xs)))))
(defcustom lsp-clients-typescript-preferences nil
"Preferences passed to the Typescript (tsserver) process.
See https://github.com/typescript-language-server/typescript-language-server#initializationoptions for the list of preferences available in the latest version of TypeScript."
:group 'lsp-typescript
:type 'plist)
(defcustom lsp-clients-typescript-tsserver nil
"Options related to the tsserver process. See below for more info.
See https://github.com/typescript-language-server/typescript-language-server#initializationoptions for the list of tsserver available in the latest version of TypeScript."
:group 'lsp-typescript
:type 'plist)
(defcustom lsp-typescript-tsdk nil
"Specifies the folder path containing tsserver and lib*.d.ts files to use."
:type '(repeat string)
:group 'lsp-vetur
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-disable-automatic-type-acquisition nil
"Disables automatic type acquisition.
Automatic type acquisition fetches `@types` packages from npm to improve
IntelliSense for external libraries."
:type 'boolean
:group 'lsp-vetur
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-npm nil
"Specifies the path to the NPM exec used for Automatic Type Acquisition.
Requires using TypeScript 2.3.4 or newer in the
workspace."
:type '(repeat string)
:group 'lsp-vetur
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-check-npm-is-installed t
"Check if NPM is installed for Automatic Type Acquisition."
:type 'boolean
:group 'lsp-vetur
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-references-code-lens-enabled nil
"Enable/disable references CodeLens in JavaScript files."
:type 'boolean
:group 'lsp-vetur
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-references-code-lens-enabled nil
"Enable/disable references CodeLens in TypeScript files."
:type 'boolean
:group 'lsp-vetur
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-implementations-code-lens-enabled nil
"Enable/disable implementations CodeLens.
This CodeLens shows the implementers of an interface."
:type 'boolean
:group 'lsp-vetur
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-tsserver-log "off"
"Enables logging of the TS server to a file.
This log can be used to diagnose TS Server issues. The log may contain file
paths, source code, and other potentially sensitive information
from your project."
:type '(choice
(const "off")
(const "terse")
(const "normal")
(const "verbose"))
:group 'lsp-vetur
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-tsserver-plugin-paths nil
"Additional paths to discover Typescript Language Service plugins.
Requires using TypeScript 2.3.0 or newer in the
workspace."
:type '(repeat string)
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-tsserver-trace "off"
"Enables tracing of messages sent to the TS server.
This trace can be used to diagnose TS Server issues. The trace may contain
file paths, source code, and other potentially sensitive
information from your project."
:type '(choice
(const "off")
(const "messages")
(const "verbose"))
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-suggest-complete-function-calls nil
"Complete functions with their parameter signature."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-suggest-complete-function-calls nil
"Complete functions with their parameter signature."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-report-style-checks-as-warnings t
"Report style checks as warnings."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-validate-enable t
"Enable/disable TypeScript validation."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-enable t
"Enable/disable default TypeScript formatter."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-insert-space-after-comma-delimiter t
"Defines space handling after a comma delimiter."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-insert-space-after-constructor nil
"Defines space handling after the constructor keyword.
Requires using TypeScript 2.3.0 or newer in the workspace."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-insert-space-after-semicolon-in-for-statements t
"Defines space handling after a semicolon in a for statement."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-insert-space-before-and-after-binary-operators t
"Defines space handling after a binary operator."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-insert-space-after-keywords-in-control-flow-statements t
"Defines space handling after keywords in a control flow statement."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-insert-space-after-function-keyword-for-anonymous-functions t
"Defines space handling after function keyword for anonymous functions."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-insert-space-before-function-parenthesis nil
"Defines space handling before function argument parentheses."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-insert-space-after-opening-and-before-closing-empty-braces nil
"Defines space handling after opening/before closing empty braces."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-insert-space-after-opening-and-before-closing-nonempty-parenthesis nil
"Defines space handling after opening/before closing non-empty parenthesis."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-insert-space-after-opening-and-before-closing-nonempty-brackets nil
"Defines space handling after opening and before closing non-empty brackets."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-insert-space-after-opening-and-before-closing-nonempty-braces t
"Defines space handling after opening and before closing non-empty braces.
Requires using TypeScript 2.3.0 or newer in the workspace."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-insert-space-after-opening-and-before-closing-template-string-braces nil
"Defines space handling after opening/before closing template string braces."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-insert-space-after-opening-and-before-closing-jsx-expression-braces nil
"Defines space handling after opening/before closing JSX expression braces."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-insert-space-after-type-assertion nil
"Defines space handling after type assertions in TypeScript.
Requires using TypeScript 2.4 or newer in the workspace."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-place-open-brace-on-new-line-for-functions nil
"Defines whether an open brace is put onto a new line for functions or not."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-format-place-open-brace-on-new-line-for-control-blocks nil
"Defines whether an open brace is put onto a newline for control blocks."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-validate-enable t
"Enable/disable JavaScript validation."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-format-enable t
"Enable/disable default JavaScript formatter."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-format-insert-space-after-comma-delimiter t
"Defines space handling after a comma delimiter."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-format-insert-space-after-constructor nil
"Defines space handling after the constructor keyword.
Requires using TypeScript 2.3.0 or newer in the workspace."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-format-insert-space-after-semicolon-in-for-statements t
"Defines space handling after a semicolon in a for statement."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-format-insert-space-before-and-after-binary-operators t
"Defines space handling after a binary operator."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-format-insert-space-after-keywords-in-control-flow-statements t
"Defines space handling after keywords in a control flow statement."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-format-insert-space-after-function-keyword-for-anonymous-functions t
"Defines space handling after function keyword for anonymous functions."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-format-insert-space-before-function-parenthesis nil
"Defines space handling before function argument parentheses."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-format-insert-space-after-opening-and-before-closing-empty-braces nil
"Defines space handling after opening/before closing empty braces."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-format-insert-space-after-opening-and-before-closing-nonempty-parenthesis nil
"Defines space handling after opening and before closing non-empty parenthesis."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-format-insert-space-after-opening-and-before-closing-nonempty-brackets nil
"Defines space handling after opening and before closing non-empty brackets."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-format-insert-space-after-opening-and-before-closing-nonempty-braces t
"Defines space handling after opening and before closing non-empty braces.
Requires using TypeScript 2.3.0 or newer in the workspace."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-format-insert-space-after-opening-and-before-closing-template-string-braces nil
"Defines space handling after opening/before closing template string braces."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-format-insert-space-after-opening-and-before-closing-jsx-expression-braces nil
"Defines space handling after opening/before closing JSX expression braces."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-format-place-open-brace-on-new-line-for-functions nil
"Defines whether an open brace is put onto a new line for functions or not."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-format-place-open-brace-on-new-line-for-control-blocks nil
"Defines whether an open brace is put onto a new line for control blocks or not."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-implicit-project-config-check-js nil
"Enable/disable semantic checking of JavaScript files.
Existing jsconfig.json or tsconfig.json files override this setting.
Requires using TypeScript 2.3.1 or newer in the workspace."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-implicit-project-config-experimental-decorators nil
nil
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-suggest-names t
"Enable/disable including unique names from the file in JavaScript suggestions."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-tsc-auto-detect "on"
"Controls auto detection of tsc tasks."
:type '(choice
(const "on")
(const "off")
(const "build")
(const "watch"))
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-suggest-paths t
"Enable/disable suggestions for paths in import statements and require calls."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-suggest-paths t
"Enable/disable suggestions for paths in import statements and require calls."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-suggest-auto-imports t
"Enable/disable auto import suggestions.
Requires using TypeScript 2.6.1 or newer in the workspace."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-suggest-auto-imports t
"Enable/disable auto import suggestions. Requires using
TypeScript 2.6.1 or newer in the workspace."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-suggest-complete-js-docs t
"Enable/disable suggestion to complete JSDoc comments."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-suggest-complete-js-docs t
"Enable/disable suggestion to complete JSDoc comments."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-locale nil
nil
:type '(choice
(const "de")
(const "es")
(const "en")
(const "fr")
(const "it")
(const "ja")
(const "ko")
(const "ru")
(const "zh-CN")
(const "zh-TW")
(const :tag "default" nil))
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-suggestion-actions-enabled t
"Enable/disable suggestion diagnostics for JavaScript files in
the editor. Requires using TypeScript 2.8 or newer in the
workspace."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-suggestion-actions-enabled t
"Enable/disable suggestion diagnostics for TypeScript files in
the editor. Requires using TypeScript 2.8 or newer in the
workspace."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-preferences-quote-style "auto" nil
:type '(choice
(const "auto")
(const "single")
(const "double"))
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-preferences-quote-style "auto" nil
:type '(choice
(const "auto")
(const "single")
(const "double"))
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-preferences-import-module-specifier "auto"
"Preferred path style for auto imports."
:type '(choice
(const "auto")
(const "relative")
(const "non-relative"))
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-preferences-import-module-specifier-preference "shortest"
"Infer the shortest path type."
:type '(choice
(const "shortest")
(const "project-relative")
(const "relative")
(const "non-relative"))
:package-version '(lsp-mode . "9.0.1"))
(defcustom lsp-typescript-preferences-import-module-specifier-ending "auto"
"Determines whether we import `foo/index.ts' as `foo', `foo/index',
or `foo/index.js'"
:type '(choice
(const "auto")
(const "minimal")
(const "index")
(const "js"))
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-preferences-rename-shorthand-properties t
"Enable/disable introducing aliases for object shorthand
properties during renames. Requires using TypeScript 3.4 or newer
in the workspace."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-preferences-rename-shorthand-properties t
"Enable/disable introducing aliases for object shorthand
properties during renames. Requires using TypeScript 3.4 or newer
in the workspace."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-update-imports-on-file-move-enabled "prompt"
"Enable/disable automatic updating of import paths when you
rename or move a file in VS Code. Requires using TypeScript 2.9
or newer in the workspace."
:type '(choice
(const "prompt")
(const "always")
(const "never"))
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-update-imports-on-file-move-enabled "prompt"
"Prompt on each rename."
:type '(choice
(const "prompt")
(const "always")
(const "never"))
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-auto-closing-tags t
"Enable/disable automatic closing of JSX tags. Requires using
TypeScript 3.0 or newer in the workspace."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-auto-closing-tags t
"Enable/disable automatic closing of JSX tags. Requires using
TypeScript 3.0 or newer in the workspace."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-suggest-enabled t
"Enabled/disable autocomplete suggestions."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-suggest-enabled t
"Enabled/disable autocomplete suggestions."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-typescript-surveys-enabled t
"Enabled/disable occasional surveys that help us improve VS
Code's JavaScript and TypeScript support."
:type 'boolean
:package-version '(lsp-mode . "6.1"))
(defcustom lsp-javascript-display-enum-member-value-hints nil
"Show inlay hints for enum member values."
:type 'boolean
:package-version '(lsp-mode . "9.0.0"))
(defcustom lsp-javascript-display-return-type-hints nil
"Show inlay hints for function return types."
:type 'boolean
:package-version '(lsp-mode . "9.0.0"))
(defcustom lsp-javascript-display-parameter-type-hints nil
"Show inlay hints for function parameters."
:type 'boolean
:package-version '(lsp-mode . "9.0.0"))
(defcustom lsp-javascript-display-parameter-name-hints "none"
"Level of hinting for parameter types."
:type '(choice (const :tag "none" "none")
(const :tag "literals" "literals")
(const :tag "all" "all"))
:package-version '(lsp-mode . "9.0.0"))
(defcustom lsp-javascript-display-parameter-name-hints-when-argument-matches-name nil
"Show inlay hints for function parameters even when argument matches
name (e.g. `data' variable passed as `data' parameter)."
:type 'boolean
:package-version '(lsp-mode . "9.0.0"))
(defcustom lsp-javascript-display-property-declaration-type-hints nil
"Show inlay hints for property declaration types."
:type 'boolean
:package-version '(lsp-mode . "9.0.0"))
(defcustom lsp-javascript-display-variable-type-hints nil
"Show inlay hints for variable types."
:type 'boolean
:package-version '(lsp-mode . "9.0.0"))
(defcustom lsp-javascript-completions-complete-function-calls t
"Complete function calls."
:type 'boolean
:package-version '(lsp-mode . "9.0.0"))
(lsp-register-custom-settings
'(("javascript.autoClosingTags" lsp-javascript-auto-closing-tags t)
("javascript.implicitProjectConfig.checkJs" lsp-javascript-implicit-project-config-check-js t)
("javascript.implicitProjectConfig.experimentalDecorators" lsp-javascript-implicit-project-config-experimental-decorators t)
("javascript.preferences.importModuleSpecifier" lsp-javascript-preferences-import-module-specifier)
("javascript.preferences.quoteStyle" lsp-javascript-preferences-quote-style)
("javascript.preferences.renameShorthandProperties" lsp-javascript-preferences-rename-shorthand-properties t)
("javascript.referencesCodeLens.enabled" lsp-javascript-references-code-lens-enabled t)
("javascript.suggest.autoImports" lsp-javascript-suggest-auto-imports t)
("javascript.suggest.completeFunctionCalls" lsp-javascript-suggest-complete-function-calls t)
("javascript.suggest.completeJSDocs" lsp-javascript-suggest-complete-js-docs t)
("javascript.suggest.enabled" lsp-javascript-suggest-enabled t)
("javascript.suggest.names" lsp-javascript-suggest-names t)
("javascript.suggest.paths" lsp-javascript-suggest-paths t)
("javascript.suggestionActions.enabled" lsp-javascript-suggestion-actions-enabled t)
("javascript.updateImportsOnFileMove.enabled" lsp-javascript-update-imports-on-file-move-enabled)
("javascript.validate.enable" lsp-javascript-validate-enable t)
("javascript.format.enable" lsp-javascript-format-enable t)
("javascript.format.insertSpaceAfterCommaDelimiter" lsp-javascript-format-insert-space-after-comma-delimiter t)
("javascript.format.insertSpaceAfterConstructor" lsp-javascript-format-insert-space-after-constructor t)
("javascript.format.insertSpaceAfterFunctionKeywordForAnonymousFunctions" lsp-javascript-format-insert-space-after-function-keyword-for-anonymous-functions t)
("javascript.format.insertSpaceAfterKeywordsInControlFlowStatements" lsp-javascript-format-insert-space-after-keywords-in-control-flow-statements t)
("javascript.format.insertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces" lsp-javascript-format-insert-space-after-opening-and-before-closing-jsx-expression-braces t)
("javascript.format.insertSpaceAfterOpeningAndBeforeClosingEmptyBraces" lsp-javascript-format-insert-space-after-opening-and-before-closing-empty-braces t)
("javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces" lsp-javascript-format-insert-space-after-opening-and-before-closing-nonempty-braces t)
("javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets" lsp-javascript-format-insert-space-after-opening-and-before-closing-nonempty-brackets t)
("javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis" lsp-javascript-format-insert-space-after-opening-and-before-closing-nonempty-parenthesis t)
("javascript.format.insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces" lsp-javascript-format-insert-space-after-opening-and-before-closing-template-string-braces t)
("javascript.format.insertSpaceAfterSemicolonInForStatements" lsp-javascript-format-insert-space-after-semicolon-in-for-statements t)
("javascript.format.insertSpaceBeforeAndAfterBinaryOperators" lsp-javascript-format-insert-space-before-and-after-binary-operators t)
("javascript.format.insertSpaceBeforeFunctionParenthesis" lsp-javascript-format-insert-space-before-function-parenthesis t)
("javascript.format.placeOpenBraceOnNewLineForControlBlocks" lsp-javascript-format-place-open-brace-on-new-line-for-control-blocks t)
("javascript.format.placeOpenBraceOnNewLineForFunctions" lsp-javascript-format-place-open-brace-on-new-line-for-functions t)
("typescript.autoClosingTags" lsp-typescript-auto-closing-tags t)
("typescript.check.npmIsInstalled" lsp-typescript-check-npm-is-installed t)
("typescript.disableAutomaticTypeAcquisition" lsp-typescript-disable-automatic-type-acquisition t)
("typescript.implementationsCodeLens.enabled" lsp-typescript-implementations-code-lens-enabled t)
("typescript.locale" lsp-typescript-locale)
("typescript.npm" lsp-typescript-npm)
("typescript.preferences.importModuleSpecifierPreference" lsp-typescript-preferences-import-module-specifier-preference)
("typescript.preferences.importModuleSpecifierEnding" lsp-typescript-preferences-import-module-specifier-ending)
("typescript.preferences.quoteStyle" lsp-typescript-preferences-quote-style)
("typescript.preferences.renameShorthandProperties" lsp-typescript-preferences-rename-shorthand-properties t)
("typescript.referencesCodeLens.enabled" lsp-typescript-references-code-lens-enabled t)
("typescript.reportStyleChecksAsWarnings" lsp-typescript-report-style-checks-as-warnings t)
("typescript.suggest.autoImports" lsp-typescript-suggest-auto-imports t)
("typescript.suggest.completeFunctionCalls" lsp-typescript-suggest-complete-function-calls t)
("typescript.suggest.completeJSDocs" lsp-typescript-suggest-complete-js-docs t)
("typescript.suggest.enabled" lsp-typescript-suggest-enabled t)
("typescript.suggest.paths" lsp-typescript-suggest-paths t)
("typescript.suggestionActions.enabled" lsp-typescript-suggestion-actions-enabled t)
("typescript.surveys.enabled" lsp-typescript-surveys-enabled t)
("typescript.tsc.autoDetect" lsp-typescript-tsc-auto-detect)
("typescript.tsdk" lsp-typescript-tsdk)
("typescript.tsserver.log" lsp-typescript-tsserver-log)
("typescript.tsserver.pluginPaths" lsp-typescript-tsserver-plugin-paths)
("typescript.tsserver.trace" lsp-typescript-tsserver-trace)
("typescript.updateImportsOnFileMove.enabled" lsp-typescript-update-imports-on-file-move-enabled)
("typescript.validate.enable" lsp-typescript-validate-enable t)
("typescript.format.enable" lsp-typescript-format-enable t)
("typescript.format.insertSpaceAfterCommaDelimiter" lsp-typescript-format-insert-space-after-comma-delimiter t)
("typescript.format.insertSpaceAfterConstructor" lsp-typescript-format-insert-space-after-constructor t)
("typescript.format.insertSpaceAfterFunctionKeywordForAnonymousFunctions" lsp-typescript-format-insert-space-after-function-keyword-for-anonymous-functions t)
("typescript.format.insertSpaceAfterKeywordsInControlFlowStatements" lsp-typescript-format-insert-space-after-keywords-in-control-flow-statements t)
("typescript.format.insertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces" lsp-typescript-format-insert-space-after-opening-and-before-closing-jsx-expression-braces t)
("typescript.format.insertSpaceAfterOpeningAndBeforeClosingEmptyBraces" lsp-typescript-format-insert-space-after-opening-and-before-closing-empty-braces t)
("typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces" lsp-typescript-format-insert-space-after-opening-and-before-closing-nonempty-braces t)
("typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets" lsp-typescript-format-insert-space-after-opening-and-before-closing-nonempty-brackets t)
("typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis" lsp-typescript-format-insert-space-after-opening-and-before-closing-nonempty-parenthesis t)
("typescript.format.insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces" lsp-typescript-format-insert-space-after-opening-and-before-closing-template-string-braces t)
("typescript.format.insertSpaceAfterSemicolonInForStatements" lsp-typescript-format-insert-space-after-semicolon-in-for-statements t)
("typescript.format.insertSpaceAfterTypeAssertion" lsp-typescript-format-insert-space-after-type-assertion t)
("typescript.format.insertSpaceBeforeAndAfterBinaryOperators" lsp-typescript-format-insert-space-before-and-after-binary-operators t)
("typescript.format.insertSpaceBeforeFunctionParenthesis" lsp-typescript-format-insert-space-before-function-parenthesis t)
("typescript.format.placeOpenBraceOnNewLineForControlBlocks" lsp-typescript-format-place-open-brace-on-new-line-for-control-blocks t)
("typescript.format.placeOpenBraceOnNewLineForFunctions" lsp-typescript-format-place-open-brace-on-new-line-for-functions t)
("typescript.inlayHints.includeInlayEnumMemberValueHints" lsp-javascript-display-enum-member-value-hints t)
("typescript.inlayHints.includeInlayFunctionLikeReturnTypeHints" lsp-javascript-display-return-type-hints t)
("typescript.inlayHints.includeInlayFunctionParameterTypeHints" lsp-javascript-display-parameter-type-hints t)
("typescript.inlayHints.includeInlayParameterNameHints" lsp-javascript-display-parameter-name-hints nil)
("typescript.inlayHints.includeInlayParameterNameHintsWhenArgumentMatchesName" lsp-javascript-display-parameter-name-hints-when-argument-matches-name t)
("typescript.inlayHints.includeInlayPropertyDeclarationTypeHints" lsp-javascript-display-property-declaration-type-hints t)
("typescript.inlayHints.includeInlayVariableTypeHints" lsp-javascript-display-variable-type-hints t)
("javascript.inlayHints.includeInlayEnumMemberValueHints" lsp-javascript-display-enum-member-value-hints t)
("javascript.inlayHints.includeInlayFunctionLikeReturnTypeHints" lsp-javascript-display-return-type-hints t)
("javascript.inlayHints.includeInlayFunctionParameterTypeHints" lsp-javascript-display-parameter-type-hints t)
("javascript.inlayHints.includeInlayParameterNameHints" lsp-javascript-display-parameter-name-hints nil)
("javascript.inlayHints.includeInlayParameterNameHintsWhenArgumentMatchesName" lsp-javascript-display-parameter-name-hints-when-argument-matches-name t)
("javascript.inlayHints.includeInlayPropertyDeclarationTypeHints" lsp-javascript-display-property-declaration-type-hints t)
("javascript.inlayHints.includeInlayVariableTypeHints" lsp-javascript-display-variable-type-hints t)
("completions.completeFunctionCalls" lsp-javascript-completions-complete-function-calls t)))
(lsp-dependency 'typescript-language-server
'(:system lsp-clients-typescript-tls-path)
'(:npm :package "typescript-language-server"
:path "typescript-language-server"))
(lsp-dependency 'typescript
'(:system "tsserver")
'(:npm :package "typescript"
:path "tsserver"))
(defun lsp-javascript--rename (_workspace args)
(let ((path (lsp--uri-to-path (lsp-get (lsp-get args :textDocument) :uri))))
(if (f-exists? path)
(with-current-buffer (find-file path)
(goto-char (lsp--position-to-point
(lsp-get args :position))))
(error "There is no file %s" path)))
(call-interactively #'lsp-rename)
nil)
(defun lsp-javascript-rename-file ()
"Rename current file and all it's references in other files."
(interactive)
(let* ((name (buffer-name))
(old (buffer-file-name))
(basename (file-name-nondirectory old)))
(unless (and old (file-exists-p old))
(error "Buffer '%s' is not visiting a file." name))
(let ((new (read-file-name "New name: " (file-name-directory old) basename nil basename)))
(when (get-file-buffer new)
(error "A buffer named '%s' already exists." new))
(when (file-exists-p new)
(error "A file named '%s' already exists." new))
(lsp--send-execute-command
"_typescript.applyRenameFile"
(vector (list :sourceUri (lsp--buffer-uri)
:targetUri (lsp--path-to-uri new))))
(mkdir (file-name-directory new) t)
(rename-file old new)
(rename-buffer new)
(set-visited-file-name new)
(set-buffer-modified-p nil)
(lsp-disconnect)
(setq-local lsp-buffer-uri nil)
(lsp)
(lsp--info "Renamed '%s' to '%s'." name (file-name-nondirectory new)))))
(defun lsp-javascript-initialized? ()
(when-let ((workspace (lsp-find-workspace 'ts-ls (buffer-file-name))))
(eq 'initialized (lsp--workspace-status workspace))))
(defun lsp-clients-typescript-require-resolve (&optional dir)
"Get the location of the typescript.
Use Node.js require.
The node_modules directory structure is suspect
and should be trusted as little as possible.
If you call require in Node.js,
it should take into account the various hooks.
For example, yarn PnP.
Optional argument DIR specifies the working directory
to run the command in."
(when-let*
((default-directory (or dir default-directory))
(output
(string-trim-right
(shell-command-to-string
"node -e \"console.log(require.resolve('typescript'))\"")))
(not-empty (not (string-empty-p output))))
(f-parent output)))
(defun lsp-clients-typescript-server-path ()
"Return the TS server path based on settings."
(if-let* ((use-project-ts lsp-clients-typescript-prefer-use-project-ts-server)
(server-path (lsp-clients-typescript-require-resolve))
(server-path-exist (f-exists? server-path)))
server-path
(if (memq system-type '(cygwin windows-nt ms-dos))
;; The Windows environment does not recognize the top-level PATH returned by `lsp-package-path',
;; so the real PATH is returned through Node.js.
(lsp-clients-typescript-require-resolve (f-parent (lsp-package-path 'typescript)))
(lsp-package-path 'typescript))))
(lsp-register-client
(make-lsp-client :new-connection (lsp-stdio-connection (lambda ()
`(,(lsp-package-path 'typescript-language-server)
,@lsp-clients-typescript-server-args)))
:activation-fn 'lsp-typescript-javascript-tsx-jsx-activate-p
:priority -2
:completion-in-comments? t
:initialization-options (lambda ()
(append
(when lsp-clients-typescript-disable-automatic-typing-acquisition
(list :disableAutomaticTypingAcquisition lsp-clients-typescript-disable-automatic-typing-acquisition))
(when lsp-clients-typescript-log-verbosity
(list :logVerbosity lsp-clients-typescript-log-verbosity))
(when lsp-clients-typescript-max-ts-server-memory
(list :maxTsServerMemory lsp-clients-typescript-max-ts-server-memory))
(when lsp-clients-typescript-npm-location
(list :npmLocation lsp-clients-typescript-npm-location))
(when lsp-clients-typescript-plugins
(list :plugins lsp-clients-typescript-plugins))
(when lsp-clients-typescript-preferences
(list :preferences lsp-clients-typescript-preferences))
`(:tsserver ( :path ,(lsp-clients-typescript-server-path)
,@lsp-clients-typescript-tsserver))))
:initialized-fn (lambda (workspace)
(with-lsp-workspace workspace
(lsp--set-configuration
(ht-merge (lsp-configuration-section "javascript")
(lsp-configuration-section "typescript")
(lsp-configuration-section "completions")
(lsp-configuration-section "diagnostics"))))
(let ((caps (lsp--workspace-server-capabilities workspace))
(format-enable (or lsp-javascript-format-enable lsp-typescript-format-enable)))
(lsp:set-server-capabilities-document-formatting-provider? caps format-enable)
(lsp:set-server-capabilities-document-range-formatting-provider? caps format-enable)))
:ignore-messages '("readFile .*? requested by TypeScript but content not available")
:server-id 'ts-ls
:request-handlers (ht ("_typescript.rename" #'lsp-javascript--rename))
:download-server-fn (lambda (_client callback error-callback _update?)
(lsp-package-ensure
'typescript
(-partial #'lsp-package-ensure
'typescript-language-server
callback
error-callback)
error-callback))))
(defgroup lsp-flow nil
"LSP support for the Flow Javascript type checker."
:group 'lsp-mode
:link '(url-link "https://flow.org"))
(defcustom lsp-clients-flow-server "flow"
"The Flow executable to use.
Leave as just the executable name to use the default behavior of
finding the executable with variable `exec-path'."
:group 'lsp-flow
:risky t
:type 'file)
(defcustom lsp-clients-flow-server-args '("lsp")
"Extra arguments for starting the Flow language server."
:group 'lsp-flow
:risky t
:type '(repeat string))
(defun lsp-clients-flow-tag-file-present-p (file-name)
"Check if the '// @flow' or `/* @flow */' tag is present in
the contents of FILE-NAME."
(if-let ((buffer (find-buffer-visiting file-name)))
(with-current-buffer buffer
(lsp-clients-flow-tag-string-present-p))
(with-temp-buffer
(insert-file-contents file-name)
(lsp-clients-flow-tag-string-present-p))))
(defun lsp-clients-flow-tag-string-present-p ()
"Helper for `lsp-clients-flow-tag-file-present-p' that works
with the file contents."
(save-excursion
(goto-char (point-min))
(let (stop found)
(while (not stop)
(unless (re-search-forward "[^\n[:space:]]" nil t)
(setq stop t))
(if (= (point) (point-min)) (setq stop t) (backward-char))
(cond ((or (looking-at-p "//+[ ]*@flow")
(looking-at-p "/\\**[ ]*@flow")
(looking-at-p "[ ]*\\*[ ]*@flow"))
(setq found t) (setq stop t))
((or (looking-at-p "//") (looking-at-p "*"))
(forward-line))
((looking-at-p "/\\*")
(save-excursion
(unless (re-search-forward "*/" nil t) (setq stop t)))
(forward-line))
(t (setq stop t))))
found)))
(defun lsp-clients-flow-project-p (file-name)
"Check if FILE-NAME is part of a Flow project, that is, if
there is a .flowconfig file in the folder hierarchy."
(locate-dominating-file file-name ".flowconfig"))
(defun lsp-clients-flow-activate-p (file-name _mode)
"Check if the Flow language server should be enabled for a
particular FILE-NAME and MODE."
(and (derived-mode-p 'js-mode 'web-mode 'js2-mode 'flow-js2-mode 'rjsx-mode)
(not (derived-mode-p 'json-mode))
(or (lsp-clients-flow-project-p file-name)
(lsp-clients-flow-tag-file-present-p file-name))))
(lsp-register-client
(make-lsp-client :new-connection
(lsp-stdio-connection (lambda ()
(cons lsp-clients-flow-server
lsp-clients-flow-server-args)))
:priority -1
:activation-fn 'lsp-clients-flow-activate-p
:server-id 'flow-ls))
(defgroup lsp-deno nil
"LSP support for the Deno language server."
:group 'lsp-mode
:link '(url-link "https://deno.land/"))
(defcustom lsp-clients-deno-server "deno"
"The Deno executable to use.
Leave as just the executable name to use the default behavior of
finding the executable with variable `exec-path'."
:group 'lsp-deno
:risky t
:type 'file
:package-version '(lsp-mode . "8.0.0"))
(defcustom lsp-clients-deno-server-args '("lsp")
"Extra arguments for starting the Deno language server."
:group 'lsp-deno
:risky t
:type '(repeat string)
:package-version '(lsp-mode . "8.0.0"))
(defcustom lsp-clients-deno-enable-lint t
"Controls if linting information will be provided by the Deno Language Server."
:group 'lsp-deno
:risky t
:type 'boolean
:package-version '(lsp-mode . "8.0.0"))
(defcustom lsp-clients-deno-enable-code-lens-references t
"Enables or disables the display of code lens information."
:group 'lsp-deno
:risky t
:type 'boolean
:package-version '(lsp-mode . "8.0.0"))
(defcustom lsp-clients-deno-enable-code-lens-references-all-functions t
"Enables or disables the display of code lens information for all functions.
Setting this variable to `non-nil' implicitly enables
`lsp-clients-deno-enable-code-lens-references'."
:group 'lsp-deno
:risky t
:type 'boolean
:package-version '(lsp-mode . "8.0.0"))