This repository has been archived by the owner on Mar 14, 2023. It is now read-only.
forked from neoclide/coc.nvim
-
Notifications
You must be signed in to change notification settings - Fork 0
/
coc.txt
2826 lines (1775 loc) · 74.5 KB
/
coc.txt
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
*coc-nvim.txt* LSP support for Vim & Neovim.
Version: 0.0.78
Author: Qiming Zhao <chemzqm at gmail.com>
License: MIT license
CONTENTS *coc-contents*
Introduction |coc-introduction|
Requirements |coc-requirements|
Installation |coc-installation|
Configuration |coc-configuration|
Completion |coc-completion|
Interface |coc-interface|
Key mappings |coc-key-mappings|
Variables |coc-variables|
Functions |coc-functions|
Commands |coc-commands|
Autocmds |coc-autocmds|
Highlights |coc-highlights|
List |coc-list|
List command |coc-list-command|
List configuration |coc-list-configuration|
List mappings |coc-list-mappings|
list sources |coc-list-sources|
Location |coc-list-location|
Extensions |coc-list-extensions|
Diagnostics |coc-list-diagnostics|
Outline |coc-list-outline|
Symbols |coc-list-symbols|
Services |coc-list-services|
Commands |coc-list-commands|
Links |coc-list-links|
Output |coc-list-output|
Sources |coc-list-completion-sources|
Lists |coc-list-lists|
Statusline support |coc-status|
Manual |coc-status-manual|
Airline |coc-status-airline|
Lightline |coc-status-lightline|
FAQ |coc-faq|
Changelog |coc-changelog|
==============================================================================
INTRODUCTION *coc-introduction*
Coc.nvim enhances your (Neo)Vim to match the user experience provided by VSCode
through rich plugin ecosystem and Language Server Protocol support.
Some of the features include:~
- APIs that are compatible with both Vim (>= 8.0) and Neovim.
- Loading VSCode-like extensions.
- Configuring coc.nvim and its extensions by using JSON configuration file.
- Configuring Language Servers that implement Language Server Protocol (LSP).
It's designed to have a good integration with other Vim plugins as much as
possible.
Coc.nvim is configurable and you can control the features that you want
through the options for the best experience.
==============================================================================
REQUIREMENTS *coc-requirements*
Note: this plugin requires Neovim >= 0.3.0 or Vim >= 8.0.
* Neovim >= 0.3.0 or Vim >= 8.0
* NodeJS (download from https://nodejs.org/en/download/ or install through your
favorite package manager)
If those requirements are not satisfied, the plugin will not load at all.
==============================================================================
INSTALLATION *coc-installation*
If you're using [vim-plug](https://github.com/junegunn/vim-plug), add this to
your `init.vim` or `.vimrc`: >
Plug 'neoclide/coc.nvim', {'branch': 'release'}
And run: >
:PlugInstall
For other plugin managers, use code from the release branch.
Or use Vim's built-in plugin ecosystem: >
#!/bin/sh
# for vim8
mkdir -p ~/.vim/pack/coc/start
cd ~/.vim/pack/coc/start
curl --fail -L https://github.com/neoclide/coc.nvim/archive/release.tar.gz|tar xzfv -
# for neovim
mkdir -p ~/.local/share/nvim/site/pack/coc/start
cd ~/.local/share/nvim/site/pack/coc/start
curl --fail -L https://github.com/neoclide/coc.nvim/archive/release.tar.gz|tar xzfv -
==============================================================================
CONFIGURATION *coc-configuration*
Configurations of coc.nvim are stored in file names `coc-settings.json` that
can be opened using |:CocConfig| for user configuration file or
|:CocLocalConfig| for local configuration file.
The location of global configuration can be configured by `g:coc_config_home`.
Configure |b:coc_root_patterns| for project root resolve.
To enable JSON completion and validation support of the settings file, install
the `coc-json` extension by command:
CocInstall coc-json
Check out https://github.com/neoclide/coc.nvim/wiki/Using-the-configuration-file
for more details.
Built-in configurations:~
*coc-config-http*
"http.proxy":~
HTTP proxy URI, used for extensions that send request, default: `""`
"http.proxyStrictSSL":~
Controls whether the proxy server certificate should be verified
against the list of supplied CAs, default: `true`
*coc-config-suggest*
"suggest.enablePreselect":~
Enable preselect feature on Neovim, default: `false`
"suggest.maxPreviewWidth":~
Maximum width of floating preview window, default: `80`
"suggest.labelMaxLength":~
Maximum length of label shown in 'pum', default: `200`
"suggest.enablePreview":~
Add preview option to 'completeopt', default: `false`
"suggest.floatEnable":~
Enable floating window for documentation when possible, default: `true`
"suggest.detailMaxLength":~
Max length of detail that will be shown in popup menu, default: `100`
"suggest.detailField":~
Where to add the detail in complete item when it's less than max
length, default: `"menu"`
Valid options: ["abbr", "menu", "preview"]
"suggest.autoTrigger":~
How should completion be triggered, default: `"always"`
Valid options: ["always", "trigger", "none"]
- `always`: trigger suggest on word characters and trigger
characters.
- `trigger`: trigger suggest on trigger characters only.
- `none`: no auto trigger at all.
"suggest.languageSourcePriority":~
Priority of language sources, default: `99`
"suggest.numberSelect":~
Input number to select complete item, it could be wrong when
using '<up>' and '<down>' to select complete item, default: `false`
"suggest.disableKind":~
Remove kind field from Vim complete item, default: `false`
"suggest.disableMenu":~
Remove menu field from Vim complete item, default: `false`
"suggest.snippetIndicator":~
The character used in completion item abbreviation to indicate it
expands as code snippet, default: `"~"`
"suggest.maxCompleteItemCount":~
Maximum number of complete items shown in Vim, default: `50`
"suggest.preferCompleteThanJumpPlaceholder":~
Confirm completion instead of jump to next placeholder when completion
activates, default: `false`
"suggest.fixInsertedWord":~
Inserted word replaces the next one, default: `true`
"suggest.localityBonus":~
Boost suggestions that appear closer to the cursor position,
default: `true`
"suggest.triggerAfterInsertEnter":~
Trigger completion after |InsertEnter|. Requires "suggest.autoTrigger"
to be set, default: `false`
"suggest.timeout":~
Timeout for completion (unit: milliseconds), default: `5000`
"suggest.minTriggerInputLength":~
Number of characters in the current word after which the completion
triggers, default: `1`
"suggest.triggerCompletionWait":~
Delay between typing the trigger character and completion start which
initiates server synchronization, default: `60`
"suggest.echodocSupport":~
Add function signature to `user_data.signature` to support `echodoc.vim`,
default: `false`
"suggest.acceptSuggestionOnCommitCharacter":~
The server provides a set of commit characters: these characters can
trigger completion item acceptance. This also inserts commit character
after the completion item text. Requires `CompleteChanged` event to work,
default: `false`
"suggest.noselect":~
Prevent Vim from selecting the first item on completion start,
default: `true`
"suggest.keepCompleteopt":~
When enabled, 'completeopt' is not overridden. Autocompletion will be
disabled if 'completeopt' doesn't have 'noinsert' and 'noselect', default:
`false`
"suggest.lowPrioritySourceLimit":~
Max items count for source priority lower than `90`.
"suggest.highPrioritySourceLimit":~
Max items count for source priority bigger than or equal to `90`.
"suggest.disableMenuShortcut":~
Disable shortcut of completion source in menu, default: `false`
"suggest.removeDuplicateItems":~
Remove completion items with duplicated word for all sources, snippet
items are excluded, default: `false`
"suggest.defaultSortMethod":~
Default sorting behavior for suggested completion items, default:
`length`
"suggest.invalidInsertCharacters":~
Invalid character for strip valid word when inserting text of complete
item, default: ` ,(,<,{,[,\r,\n`
"suggest.asciiCharactersOnly":~
Suggest ASCII characters only, default: `false`
"suggest.completionItemKindLabels":~
Set custom labels to completion item kinds, default: `{}`.
Example configuration: with https://nerdfonts.com: >
"suggest.completionItemKindLabels": {
"keyword": "\uf1de",
"variable": "\ue79b",
"value": "\uf89f",
"operator": "\u03a8",
"function": "\u0192",
"reference": "\ufa46",
"constant": "\uf8fe",
"method": "\uf09a",
"struct": "\ufb44",
"class": "\uf0e8",
"interface": "\uf417",
"text": "\ue612",
"enum": "\uf435",
"enumMember": "\uf02b",
"module": "\uf40d",
"color": "\ue22b",
"property": "\ue624",
"field": "\uf9be",
"unit": "\uf475",
"event": "\ufacd",
"file": "\uf723",
"folder": "\uf114",
"snippet": "\ue60b",
"typeParameter": "\uf728",
"default": "\uf29c"
}
<
*coc-config-diagnostic*
"diagnostic.enable":~
Display diagnostics, default: `true`
"diagnostic.enableSign":~
Enable signs for diagnostics, default: `true`
"diagnostic.enableMessage":~
When to enable show messages of diagnostics.
Valid options: ["always","jump","never"], always means including
cursor hold and after jump to another diagnostic.
default: `"always"`
"diagnostic.enableHighlightLineNumber":~
Enable highlighting line numbers for diagnostics, only works with
neovim and `diagnostic.enableSign` is true.
default: `true`
"diagnostic.level":~
Filter diagnostics by severity, default: `"hint"`
Valid options: ["hint", "information", "warning", "error"]
"diagnostic.messageDelay":~
How long to wait (in milliseconds) before displaying the diagnostic
message with echo or float.
Default: `200`
"diagnostic.maxWindowWidth":~
Maximum width of diagnostics floating window, default: `80`
"diagnostic.checkCurrentLine":~
Show all diagnostics of the current line if none of them are at the current
position, default: `false`
"diagnostic.messageTarget":~
Diagnostic message target, default: `"float"`
Valid options: ["echo", "float"]
"diagnostic.refreshOnInsertMode":~
Refresh diagnostics when in insert mode, default: `false`
"diagnostic.refreshAfterSave":~
Refresh diagnostics after file save only, default: `false`
"diagnostic.displayByAle":~
Use ALE for displaying diagnostics. This will disable coc.nvim for
displaying diagnostics. Restart to make changes take the effect, default:
`false`
"diagnostic.virtualText":~
Use Neovim virtual text to display diagnostics, default: `false`
"diagnostic.virtualTextCurrentLineOnly":~
Only show virtualText diagnostic on current cursor line, default:
`true`
"diagnostic.virtualTextPrefix":~
The prefix added for virtual text diagnostics, default: `" "`
"diagnostic.virtualTextLines":~
The number of non-empty lines from a diagnostic to display, default: `3`
"diagnostic.virtualTextLineSeparator":~
The text that will mark a line end from the diagnostic message,
default: `" \\ "`
"diagnostic.locationlist":~
Create location list for error & warning, default: `true`
"diagnostic.highlightOffset":~
Offset number of buffer.addHighlight, Neovim only, default: `1000`
"diagnostic.signOffset":~
Offset number of sign, default: `1000`
"diagnostic.errorSign":~
Sign of error diagnostics shown in the 'signcolumn', default: `">>"`
"diagnostic.warningSign":~
Sign of warning diagnostics shown in the 'signcolumn', default: `"⚠"`
"diagnostic.infoSign":~
Sign of info diagnostics shown in the 'signcolumn', default: `">>"`
"diagnostic.hintSign":~
Sign of info diagnostics shown in the 'signcolumn', default: `">>"`
"diagnostic.maxWindowHeight":~
Maximum height of diagnostics floating window, default: `8`
"diagnostic.filetypeMap":~
A map between buffer filetype and the filetype assigned to diagnostics.
To syntax highlight diagnostics withs their parent buffer type use
`"default": "bufferType"`, default: `{}`
"diagnostic.format":~
Define the diagnostic format.
Available parts: source, code, severity, message
Default: `[%source%code] [%severity] %message`
"diagnostic.separateRelatedInformationAsDiagnostics":~
Separate related information as diagnostics, default: `false`
"signature.enable":~
Enable signature help when trigger character typed. Requires service restart
on change, default: `true`
"signature.floatMaxWidth":~
Max width of signature float window, default: `60`
"signature.triggerSignatureWait":~
Delay for signature request trigger (milliseconds), default: `50`.
Change to higher value for slow Language Servers.
"signature.target":~
Target of signature help, use `"float"` when possible by default.
Valid options: ["float", "echo"]
"signature.preferShownAbove":~
Show signature help's floating window above cursor when possible. Requires
restart on change, default: `true`
"signature.hideOnTextChange":~
Hide signature help's floating window when text changed. Requires restart
on change, default: `false`
"signature.maxWindowHeight":~
Maximum height of floating window with the signature help, default: `8`
*coc-config-refactor*
"refactor.openCommand":~
Open command for refactor window, default: `vsplit`
"refactor.beforeContext":~
Print num lines of leading context before each match, default: `3`
"refactor.afterContext":~
Print num lines of trailing context after each match, default: `3`
*coc-config-codelens*
"codeLens.enable":~
Enable `codeLens` feature. Requires Neovim with virtual text feature,
default: `false`
"codeLens.separator":~
Separator text for `codeLens` in virtual text, default: `"‣"`
"codeLens.subseparator":~
Subseparator text for multiple `codeLens`es in virtual text, default: `" "`
"workspace.ignoredFiletypes":~
Filetypes to ignore for workspace folder resolution,
default: `["markdown","log","txt","help"]`
*coc-config-list*
"list.indicator":~
The character used as first character in prompt line, default: `">"`
"list.maxHeight":~
Maximum height of list window, default: `10`
"list.signOffset":~
Sign offset of list, should be different from other plugins, default: `900`
"list.selectedSignText":~
Sign text for selected lines, default: `"*"`
"list.autoResize":~
Enable auto-resize feature, default: `true`
"list.limitLines":~
Limit lines shown in the list buffer, default: `30000`
"list.maxPreviewHeight":~
Max height for preview window of list, default: `12`
"list.previewHighlightGroup":~
Highlight group used for highlighting the range in preview window,
default: `"Search"`
"list.nextKeymap":~
Key for selecting next line in the insert mode, default: `"<C-j>"`
"list.previousKeymap":~
Key for selecting previous line in the insert mode, default: `"<C-k>"`
"list.extendedSearchMode": ~
Enable extended search mode which allows multiple search patterns delimited
by spaces, default: `true`
"list.normalMappings":~
Custom key mappings in the normal mode, default: `{}`
"list.insertMappings":~
Custom key mappings in the insert mode, default: `{}`
"list.interactiveDebounceTime":~
Debouce time for input change on interactive mode, default: `100`
"list.previewSplitRight":~
Use vsplit for preview window, default: `false`
"list.source.symbols.excludes":~
Patterns of mimimatch for filepath to execlude from symbols list,
default: `[]`
"list.source.outline.ctagsFilestypes":~
Filetypes that should use `ctags` for outline instead of language server,
default: `[]`
*coc-config-preferences*
"coc.preferences.maxFileSize":~
Maximum file size in bytes that coc.nvim should handle, default: `'10MB'`
"coc.preferences.promptWorkspaceEdit":~
Prompt confirm from user for workspace edit.
default: `true`
"coc.preferences.useQuickfixForLocations":~
Use Vim's quickfix list for jump locations. Requires restart on change,
default: `false`
"coc.preferences.extensionUpdateCheck":~
Interval for checking extension updates, default: `"daily"`
Valid options: ["daily","weekly","never"]
"coc.preferences.snippetStatusText":~
Text shown in 'statusline' to indicate snippet session is activate.
Check |coc-status| for statusline integration.
Default: `"SNIP"`
"coc.preferences.hoverTarget":~
Target to show hover information, default is floating window when possible.
Valid options: ["preview", "echo", "float"]
"coc.preferences.previewAutoClose":~
Auto close preview window of hover upon cursor move, default: `true`
"coc.preferences.previewMaxHeight":~
Max height of preview window for hover, default: `12`
"coc.preferences.colorSupport":~
Enable color highlight if Language Server support it, default: `true`
"coc.preferences.currentFunctionSymbolAutoUpdate":~
Automatically update the value of `b:coc_current_function` on `CursorHold`
event, default: `false`
"coc.preferences.formatOnInsertLeave":~
Trigger format on type when insert leave by send \n to the server.
Default: `false`
"coc.preferences.formatOnSaveFiletypes":~
Filetypes for which formatting triggers after saving, default: `[]`
"coc.preferences.enableFloatHighlight":~
Enable highlight for floating window, default: `true`
"coc.preferences.rootPatterns":~
Root patterns to resolve `workspaceFolder` from parent folders of opened
files, resolved from up to down, default:
`[".git",".hg",".projections.json"]`
"coc.preferences.watchmanPath":~
Executable path for https://facebook.github.io/watchman/, detected
from $PATH by default, default: `null`
"coc.preferences.jumpCommand":~
Command used for location jump performed for goto definition, goto
references etc, default: `"edit"`
Valid options: ["edit", "split", "vsplit", "tabe", "drop", "tab drop"]
"coc.preferences.messageLevel":~
Message level for filter echoed messages default: `"more"`
Valid options: ["more", "warning", "error"]
"coc.preferences.formatOnType":~
Set to true to enable format on type, default: `false`
"coc.preferences.bracketEnterImprove":~
Improve handling of pressing enter inside brackets (`<> {} [] ()`) by
adding a new empty line below and moving the cursor to it.
Works with |coc#on_enter()|, default: `true`
"coc.preferences.formatOnTypeFiletypes":~
Filetypes that should run format on typing, default: `[]`
Note: takes effect when `coc.preferences.formatOnType` set `true`.
"coc.preferences.snippets.enable":~
Enables snippets support, default: `true`
"coc.preferences.listOfWorkspaceEdit":~
List should contains changed locations after workspace edit, default
to vim's quickfix, default: `quickfix`
"coc.preferences.highlightTimeout":~
Highlight timeout for buffer in floating window, default: `500`
*coc-config-cursors*
"cursors.cancelKey":~
Key used for cancel cursors session, default: `<esc>`
"cursors.nextKey":~
Key used for jump to next cursors position. , default: `<C-n>`
"cursors.previousKey":~
Key used for jump to previous cursors position, default: `<C-p>`
*coc-config-npm*
"npm.binPath":~
Command or full path of npm or yarn executable for install/update
extensions, default: `npm`
*coc-config-languageserver*
"languageserver":~
Dictionary of Language Servers, key is the ID of corresponding server,
and value is configuration of languageserver. Default: `{}`
Properties of languageserver configuration:
- "enable": Change to `false` to disable that languageserver.
- "filetypes": Supported filetypes, add * in array for all filetypes.
Note: it's required for start the languageserver, please make cure
your filetype is expected by `:echo &filetype` command
- "additionalSchemes": Additional uri schemes, default schemes
including file & untitled.
Note: you have to setup vim provide content for custom uri as well.
- "cwd": Working directory used to start languageserver, vim's cwd is
used by default.
- "env": Environment variables for child process.
- "settings": Settings for languageserver, received on server
initialiation.
- "trace.server": Trace level of communication between server and
client that showed with output channel.
- "stdioEncoding": Encoding used for stdio of child process.
- "initializationOptions": Initialization options passed to
languageserver (it's deprecated)
- "rootPatterns": Root patterns used to resolve rootPath from current
file.
- "requireRootPattern": If true, doesn't start server when root
pattern not found.
- "ignoredRootPaths": Absolute root paths that language server should
not use as rootPath, higher priority than rootPatterns.
- "disableDynamicRegister": Disable dynamic registerCapability feature
for this languageserver to avoid duplicated feature regstration.
- "disableWorkspaceFolders": Disable workspaceFolders feature for this
languageserver.
- "disableDiagnostics": Disable handle diagnostics for this
languageserver.
- "disableCompletion": Disable completion feature for this
languageserver.
- "revealOutputChannelOn": Configure message level to show the output
channel buffer.
- "progressOnInitialization": Enable progress report on languageserver
initialize.
Language server start with command:~
Additional fields can be used for command language server:
- "command": Executable program name in $PATH or absolute path of
executable used for start languageserver.
- "args": Command line arguments of command.
- "detached": Detach language server when is true.
- "shell": Use shell for server process, default: `false`
Language server start with module:~
Additional fields can be used forlanguage server started by node
module:
- "module": Absolute filepath of javascript file.
- "args": Extra arguments used on fork javascript module.
- "runtime": Absolute path of node runtime, node runtime of coc.nvim
is used by default.
- "execArgv": Argv passed to node on fork, normally used for
debugging, ex: `["--nolazy", "--inspect-brk=6045"]`
- "transport": Transport kind used by server, could be 'ipc', 'stdio',
'socket' and 'pipe'. 'ipc' is used by default (recommended).
- "transportPort": Port number used when transport is 'socket'.
Language server use initialized socket server:~
- "port": Port number of socket server.
- "host": Host of socket server, default to `127.0.0.1`.
==============================================================================
COMPLETION *coc-completion*
Completion triggers automatically by default, you can change completion
behavior in the configuration file.
Tips:~
- 'completeopt' used by coc.nvim default to `noselect,menuone`.
- Your 'completeopt' option would be changed and restored during completion,
so you can still use `menu,preview` for Vim's built in completion.
- Snippet expand and additional edit feature of LSP requires confirm
completion to work.
- Floating window is available on Neovim >= 0.4.0.
------------------------------------------------------------------------------
Example configuration:~
Map <tab> to trigger completion and navigate to the next item: >
function! s:check_back_space() abort
let col = col('.') - 1
return !col || getline('.')[col - 1] =~ '\s'
endfunction
inoremap <silent><expr> <TAB>
\ pumvisible() ? "\<C-n>" :
\ <SID>check_back_space() ? "\<TAB>" :
\ coc#refresh()
Map <c-space> to trigger completion: >
inoremap <silent><expr> <c-space> coc#refresh()
<
<CR> to confirm completion, use: >
inoremap <expr> <cr> pumvisible() ? "\<C-y>" : "\<CR>"
<
To make <CR> auto-select the first completion item and notify coc.nvim to
format on enter, use: >
inoremap <silent><expr> <cr> pumvisible() ? coc#_select_confirm()
\: "\<C-g>u\<CR>\<c-r>=coc#on_enter()\<CR>"
Map <tab> for trigger completion, completion confirm, snippet expand and jump
like VSCode. >
inoremap <silent><expr> <TAB>
\ pumvisible() ? coc#_select_confirm() :
\ coc#expandableOrJumpable() ? "\<C-r>=coc#rpc#request('doKeymap', ['snippets-expand-jump',''])\<CR>" :
\ <SID>check_back_space() ? "\<TAB>" :
\ coc#refresh()
function! s:check_back_space() abort
let col = col('.') - 1
return !col || getline('.')[col - 1] =~# '\s'
endfunction
let g:coc_snippet_next = '<tab>'
<
Note: the `coc-snippets` extension is required for this to work.
==============================================================================
INTERFACE *coc-interface*
------------------------------------------------------------------------------
Coc doesn't come with a default global keymap, you need to configure the
mappings yourself.
Key mappings *coc-key-mappings*
Note: Mappings that start with `i_` works for insert mode `n_` works for
normal mode, `v_` works for visual mode.
<Plug>(coc-diagnostic-info) *n_coc-diagnostic-info*
Show diagnostic message of current position, no
truncate.
<Plug>(coc-diagnostic-next) *n_coc-diagnostic-next*
Jump to next diagnostic position.
<Plug>(coc-diagnostic-prev) *n_coc-diagnostic-prev*
Jump to previous diagnostic position.
<Plug>(coc-diagnostic-next-error) *n_coc-diagnostic-next-error*
Jump to next diagnostic error position.
<Plug>(coc-diagnostic-prev-error) *n_coc-diagnostic-prev-error*
Jump to previous diagnostic error position.
<Plug>(coc-definition) *n_coc-definition*
Jump to definition(s) of current symbol.
<Plug>(coc-declaration) *n_coc-declaration*
Jump to declaration(s) of current symbol.
<Plug>(coc-implementation) *n_coc-implementation*
Jump to implementation(s) of current symbol.
<Plug>(coc-type-definition) *n_coc-type-definition*
Jump to type definition(s) of current symbol.
<Plug>(coc-references) *n_coc-references*
Jump to references of current symbol.
<Plug>(coc-format-selected) *n_coc-format-selected*
*v_coc-format-selected*
Format selected range, would work in both visual mode
and normal mode, when used in normal mode, the
selection works on the motion object.
For example: >
vmap <leader>p <Plug>(coc-format-selected)
nmap <leader>p <Plug>(coc-format-selected)
<
makes `<leader>p` format the visually selected range, and you can use
`<leader>pap` to format a paragraph.
<Plug>(coc-format) *n_coc-format*
Format the whole buffer, normally you would like to
use a command like: >
command! -nargs=0 Format :call CocAction('format')
<
to format the current buffer.
<Plug>(coc-rename) *n_coc-rename*
Rename symbol under cursor to a new word.
<Plug>(coc-codeaction) *n_coc-codeaction*
Get and run code action(s) for current file.
<Plug>(coc-codeaction-line) *n_coc-codeaction-line*
Get and run code action(s) for current line.
<Plug>(coc-codeaction-selected) *n_coc-codeaction-selected*
*v_coc-codeaction-selected*
Get and run code action(s) with the selected region.
Works with both normal and visual mode.
<Plug>(coc-openlink) *n_coc-openlink*