forked from SpaceVim/SpaceVim
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SpaceVim.txt
6669 lines (5289 loc) · 213 KB
/
SpaceVim.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
*SpaceVim.txt*
/###### /## /##/##
/##__ ## | ## | #|__/
| ## \__/ /###### /###### /####### /######| ## | ##/##/######/####
| ###### /##__ ##|____ ##/##_____//##__ #| ## / ##| #| ##_ ##_ ##
\____ #| ## \ ## /######| ## | ########\ ## ##/| #| ## \ ## \ ##
/## \ #| ## | ##/##__ #| ## | ##_____/ \ ###/ | #| ## | ## | ##
| ######| #######| ######| ######| ####### \ #/ | #| ## | ## | ##
\______/| ##____/ \_______/\_______/\_______/ \_/ |__|__/ |__/ |__/
| ##
| ##
|__/
wsdjeg *spacevim* *SpaceVim*
==============================================================================
CONTENTS *SpaceVim-contents*
1. Introduction.............................................|SpaceVim-intro|
2. Options................................................|SpaceVim-options|
1. autocomplete_method............|SpaceVim-options-autocomplete_method|
2. autocomplete_parens............|SpaceVim-options-autocomplete_parens|
3. bootstrap_after....................|SpaceVim-options-bootstrap_after|
4. bootstrap_before..................|SpaceVim-options-bootstrap_before|
5. bootstrap_script..................|SpaceVim-options-bootstrap_script|
6. buffer_index_type................|SpaceVim-options-buffer_index_type|
7. checkinstall..........................|SpaceVim-options-checkinstall|
8. code_runner_focus................|SpaceVim-options-code_runner_focus|
9. colorscheme............................|SpaceVim-options-colorscheme|
10. colorscheme_bg.....................|SpaceVim-options-colorscheme_bg|
11. commandline_prompt.............|SpaceVim-options-commandline_prompt|
12. data_dir.................................|SpaceVim-options-data_dir|
13. default_custom_leader.......|SpaceVim-options-default_custom_leader|
14. default_indent.....................|SpaceVim-options-default_indent|
15. enable_bepo_layout.............|SpaceVim-options-enable_bepo_layout|
16. enable_cursorcolumn...........|SpaceVim-options-enable_cursorcolumn|
17. enable_cursorline...............|SpaceVim-options-enable_cursorline|
18. enable_debug.........................|SpaceVim-options-enable_debug|
19. enable_googlesuggest.........|SpaceVim-options-enable_googlesuggest|
20. enable_guicolors.................|SpaceVim-options-enable_guicolors|
21. enable_key_frequency.........|SpaceVim-options-enable_key_frequency|
22. enable_projects_cache.......|SpaceVim-options-enable_projects_cache|
23. enable_statusline_bfpath.|SpaceVim-options-enable_statusline_bfpath|
24. enable_statusline_mode.....|SpaceVim-options-enable_statusline_mode|
25. enable_statusline_tag.......|SpaceVim-options-enable_statusline_tag|
26. enable_tabline_ft_icon.....|SpaceVim-options-enable_tabline_ft_icon|
27. enable_vimfiler_welcome...|SpaceVim-options-enable_vimfiler_welcome|
28. enable_ycm.............................|SpaceVim-options-enable_ycm|
29. error_symbol.........................|SpaceVim-options-error_symbol|
30. escape_key_binding.............|SpaceVim-options-escape_key_binding|
31. expand_tab.............................|SpaceVim-options-expand_tab|
32. file_searching_tools.........|SpaceVim-options-file_searching_tools|
33. filemanager...........................|SpaceVim-options-filemanager|
34. filetree_direction.............|SpaceVim-options-filetree_direction|
35. guifont...................................|SpaceVim-options-guifont|
36. home_files_number...............|SpaceVim-options-home_files_number|
37. info_symbol...........................|SpaceVim-options-info_symbol|
38. keep_server_alive...............|SpaceVim-options-keep_server_alive|
39. language.................................|SpaceVim-options-language|
40. lint_engine...........................|SpaceVim-options-lint_engine|
41. lint_on_the_fly...................|SpaceVim-options-lint_on_the_fly|
42. max_column.............................|SpaceVim-options-max_column|
43. plugin_bundle_dir...............|SpaceVim-options-plugin_bundle_dir|
44. plugin_manager_processes.|SpaceVim-options-plugin_manager_processes|
45. project_auto_root...............|SpaceVim-options-project_auto_root|
46. project_non_root.................|SpaceVim-options-project_non_root|
47. project_rooter_outermost.|SpaceVim-options-project_rooter_outermost|
48. project_rooter_patterns...|SpaceVim-options-project_rooter_patterns|
49. projects_cache_num.............|SpaceVim-options-projects_cache_num|
50. realtime_leader_guide.......|SpaceVim-options-realtime_leader_guide|
51. relativenumber.....................|SpaceVim-options-relativenumber|
52. retry_cnt...............................|SpaceVim-options-retry_cnt|
53. search_tools.........................|SpaceVim-options-search_tools|
54. sidebar_width.......................|SpaceVim-options-sidebar_width|
55. snippet_engine.....................|SpaceVim-options-snippet_engine|
56. statusline_iseparator.......|SpaceVim-options-statusline_iseparator|
57. statusline_left...................|SpaceVim-options-statusline_left|
58. statusline_right.................|SpaceVim-options-statusline_right|
59. statusline_separator.........|SpaceVim-options-statusline_separator|
60. statusline_unicode.............|SpaceVim-options-statusline_unicode|
61. terminal_cursor_shape.......|SpaceVim-options-terminal_cursor_shape|
62. todo_labels...........................|SpaceVim-options-todo_labels|
63. todo_prefix...........................|SpaceVim-options-todo_prefix|
64. vim_help_language...............|SpaceVim-options-vim_help_language|
65. vimcompatible.......................|SpaceVim-options-vimcompatible|
66. warning_symbol.....................|SpaceVim-options-warning_symbol|
67. wildignore.............................|SpaceVim-options-wildignore|
68. windisk_encoding.................|SpaceVim-options-windisk_encoding|
69. windows_index_type.............|SpaceVim-options-windows_index_type|
70. windows_leader.....................|SpaceVim-options-windows_leader|
71. windows_smartclose.............|SpaceVim-options-windows_smartclose|
3. Configuration...........................................|SpaceVim-config|
4. Commands..............................................|SpaceVim-commands|
5. Public functions.....................................|SpaceVim-functions|
6. Layers..................................................|SpaceVim-layers|
1. Chinese.....................................|SpaceVim-layers-chinese|
2. VersionControl.......................|SpaceVim-layers-VersionControl|
3. autocomplete...........................|SpaceVim-layers-autocomplete|
4. chat...........................................|SpaceVim-layers-chat|
5. checkers...................................|SpaceVim-layers-checkers|
6. colorscheme.............................|SpaceVim-layers-colorscheme|
7. core...........................................|SpaceVim-layers-core|
8. core#statusline.....................|SpaceVim-layers-core-statusline|
9. core#tabline...........................|SpaceVim-layers-core-tabline|
10. cscope......................................|SpaceVim-layers-cscope|
11. ctrlp........................................|SpaceVim-layers-ctrlp|
12. debug........................................|SpaceVim-layers-debug|
13. edit..........................................|SpaceVim-layers-edit|
14. exprfold..................................|SpaceVim-layers-exprfold|
15. foldsearch..............................|SpaceVim-layers-foldsearch|
16. format......................................|SpaceVim-layers-format|
17. fzf............................................|SpaceVim-layers-fzf|
18. git............................................|SpaceVim-layers-git|
19. github......................................|SpaceVim-layers-github|
20. gtags........................................|SpaceVim-layers-gtags|
21. incsearch................................|SpaceVim-layers-incsearch|
22. indentmove..............................|SpaceVim-layers-indentmove|
23. lang#WebAssembly..................|SpaceVim-layers-lang-WebAssembly|
24. lang#actionscript................|SpaceVim-layers-lang-actionscript|
25. lang#agda................................|SpaceVim-layers-lang-agda|
26. lang#asciidoc........................|SpaceVim-layers-lang-asciidoc|
27. lang#asepctj..........................|SpaceVim-layers-lang-asepctj|
28. lang#assembly........................|SpaceVim-layers-lang-assembly|
29. lang#autohotkey....................|SpaceVim-layers-lang-autohotkey|
30. lang#autoit............................|SpaceVim-layers-lang-autoit|
31. lang#batch..............................|SpaceVim-layers-lang-batch|
32. lang#c......................................|SpaceVim-layers-lang-c|
33. lang#chapel............................|SpaceVim-layers-lang-chapel|
34. lang#clojure..........................|SpaceVim-layers-lang-clojure|
35. lang#coffeescript................|SpaceVim-layers-lang-coffeescript|
36. lang#crystal..........................|SpaceVim-layers-lang-crystal|
37. lang#csharp............................|SpaceVim-layers-lang-csharp|
38. lang#d......................................|SpaceVim-layers-lang-d|
39. lang#dart................................|SpaceVim-layers-lang-dart|
40. lang#dockerfile....................|SpaceVim-layers-lang-dockerfile|
41. lang#e......................................|SpaceVim-layers-lang-e|
42. lang#eiffel............................|SpaceVim-layers-lang-eiffel|
43. lang#elixir............................|SpaceVim-layers-lang-elixir|
44. lang#elm..................................|SpaceVim-layers-lang-elm|
45. lang#erlang............................|SpaceVim-layers-lang-erlang|
46. lang#extra..............................|SpaceVim-layers-lang-extra|
47. lang#fennel............................|SpaceVim-layers-lang-fennel|
48. lang#forth..............................|SpaceVim-layers-lang-forth|
49. lang#fortran..........................|SpaceVim-layers-lang-fortran|
50. lang#foxpro............................|SpaceVim-layers-lang-foxpro|
51. lang#fsharp............................|SpaceVim-layers-lang-fsharp|
52. lang#go....................................|SpaceVim-layers-lang-go|
53. lang#goby................................|SpaceVim-layers-lang-goby|
54. lang#gosu................................|SpaceVim-layers-lang-gosu|
55. lang#graphql..........................|SpaceVim-layers-lang-graphql|
56. lang#groovy............................|SpaceVim-layers-lang-groovy|
57. lang#hack................................|SpaceVim-layers-lang-hack|
58. lang#haskell..........................|SpaceVim-layers-lang-haskell|
59. lang#haxe................................|SpaceVim-layers-lang-haxe|
60. lang#html................................|SpaceVim-layers-lang-html|
61. lang#hy....................................|SpaceVim-layers-lang-hy|
62. lang#idris..............................|SpaceVim-layers-lang-idris|
63. lang#io....................................|SpaceVim-layers-lang-io|
64. lang#j......................................|SpaceVim-layers-lang-j|
65. lang#janet..............................|SpaceVim-layers-lang-janet|
66. lang#java................................|SpaceVim-layers-lang-java|
67. lang#javascript....................|SpaceVim-layers-lang-javascript|
68. lang#jr....................................|SpaceVim-layers-lang-jr|
69. lang#json................................|SpaceVim-layers-lang-json|
70. lang#julia..............................|SpaceVim-layers-lang-julia|
71. lang#kotlin............................|SpaceVim-layers-lang-kotlin|
72. lang#latex..............................|SpaceVim-layers-lang-latex|
73. lang#lisp................................|SpaceVim-layers-lang-lisp|
74. lang#livescript....................|SpaceVim-layers-lang-livescript|
75. lang#lua..................................|SpaceVim-layers-lang-lua|
76. lang#markdown........................|SpaceVim-layers-lang-markdown|
77. lang#moonscript....................|SpaceVim-layers-lang-moonscript|
78. lang#nim..................................|SpaceVim-layers-lang-nim|
79. lang#nix..................................|SpaceVim-layers-lang-nix|
80. lang#ocaml..............................|SpaceVim-layers-lang-ocaml|
81. lang#octave............................|SpaceVim-layers-lang-octave|
82. lang#pact................................|SpaceVim-layers-lang-pact|
83. lang#pascal............................|SpaceVim-layers-lang-pascal|
84. lang#perl................................|SpaceVim-layers-lang-perl|
85. lang#php..................................|SpaceVim-layers-lang-php|
86. lang#plantuml........................|SpaceVim-layers-lang-plantuml|
87. lang#pony................................|SpaceVim-layers-lang-pony|
88. lang#processing....................|SpaceVim-layers-lang-processing|
89. lang#prolog............................|SpaceVim-layers-lang-prolog|
90. lang#puppet............................|SpaceVim-layers-lang-puppet|
91. lang#purescript....................|SpaceVim-layers-lang-purescript|
92. lang#python............................|SpaceVim-layers-lang-python|
93. lang#racket............................|SpaceVim-layers-lang-racket|
94. lang#racket...............................|SpaceVim-layers-lang-red|
95. lang#reason............................|SpaceVim-layers-lang-reason|
96. lang#ring...................................|SpaceVim-layers-lang-r|
97. lang#ring................................|SpaceVim-layers-lang-ring|
98. lang#ruby................................|SpaceVim-layers-lang-ruby|
99. lang#rust................................|SpaceVim-layers-lang-rust|
100. lang#scala.............................|SpaceVim-layers-lang-scala|
101. lang#scheme...........................|SpaceVim-layers-lang-scheme|
102. lang#sh...................................|SpaceVim-layers-lang-sh|
103. lang#smalltalk.....................|SpaceVim-layers-lang-smalltalk|
104. lang#sml.................................|SpaceVim-layers-lang-sml|
105. lang#swig..............................|SpaceVim-layers-lang-swift|
106. lang#swig...............................|SpaceVim-layers-lang-swig|
107. lang#tcl.................................|SpaceVim-layers-lang-tcl|
108. lang#teal...............................|SpaceVim-layers-lang-teal|
109. lang#toml...............................|SpaceVim-layers-lang-toml|
110. lang#typescript...................|SpaceVim-layers-lang-typescript|
111. lang#v.....................................|SpaceVim-layers-lang-v|
112. lang#vala...............................|SpaceVim-layers-lang-vala|
113. lang#vbnet.............................|SpaceVim-layers-lang-vbnet|
114. lang#verilog.........................|SpaceVim-layers-lang-verilog|
115. lang#vim.................................|SpaceVim-layers-lang-vim|
116. lang#vue.................................|SpaceVim-layers-lang-vue|
117. lang#wdl.................................|SpaceVim-layers-lang-wdl|
118. lang#wolfram.........................|SpaceVim-layers-lang-wolfram|
119. lang#xml.................................|SpaceVim-layers-lang-xml|
120. lang#xquery...........................|SpaceVim-layers-lang-xquery|
121. lang#zig.................................|SpaceVim-layers-lang-zig|
122. language server protocol......................|SpaceVim-layers-lsp|
123. leaderf...................................|SpaceVim-layers-leaderf|
124. mail.........................................|SpaceVim-layers-mail|
125. operator.................................|SpaceVim-layers-operator|
126. shell.......................................|SpaceVim-layers-shell|
127. ssh...........................................|SpaceVim-layers-ssh|
128. test.........................................|SpaceVim-layers-test|
129. tmux.........................................|SpaceVim-layers-tmux|
130. tools#dash.............................|SpaceVim-layers-tools-dash|
131. tools#mpv...............................|SpaceVim-layers-tools-mpv|
132. tools#zeal.............................|SpaceVim-layers-tools-zeal|
133. treesitter.............................|SpaceVim-layers-treesitter|
134. ui.............................................|SpaceVim-layers-ui|
135. unite.......................................|SpaceVim-layers-unite|
7. Usage....................................................|SpaceVim-usage|
1. alternate file........................|SpaceVim-usage-alternate-file|
2. buffers-and-files..................|SpaceVim-usage-buffers-and-files|
3. command-line-mode..................|SpaceVim-usage-command-line-mode|
4. custom_plugins........................|SpaceVim-usage-custom_plugins|
5. repl............................................|SpaceVim-usage-repl|
6. search-and-replace................|SpaceVim-usage-search-and-replace|
7. tasks..........................................|SpaceVim-usage-tasks|
8. undo-tree...................................|SpaceVim-usage-undotree|
9. windows-and-tabs....................|SpaceVim-usage-windows-and-tabs|
8. Plugins................................................|SpaceVim-plugins|
1. iedit........................................|SpaceVim-plugins-iedit|
2. runner......................................|SpaceVim-plugins-runner|
3. tab manager.............................|SpaceVim-plugins-tabmanager|
4. todo manager...........................|SpaceVim-plugins-todomanager|
9. API........................................................|SpaceVim-api|
1. clock............................................|SpaceVim-api-clock|
2. cmdlinemenu................................|SpaceVim-api-cmdlinemenu|
3. data#dict....................................|SpaceVim-api-data-dict|
4. data#list....................................|SpaceVim-api-data-list|
5. data#number................................|SpaceVim-api-data-number|
6. data#string................................|SpaceVim-api-data-string|
7. file..............................................|SpaceVim-api-file|
8. job................................................|SpaceVim-api-job|
9. logger..........................................|SpaceVim-api-logger|
10. notify.........................................|SpaceVim-api-notify|
11. password.....................................|SpaceVim-api-password|
12. prompt.........................................|SpaceVim-api-prompt|
13. sid...........................................|SpaceVim-api-vim-sid|
14. system.........................................|SpaceVim-api-system|
15. time.............................................|SpaceVim-api-time|
16. unicode#box...............................|SpaceVim-api-unicode-box|
17. vim#buffer.................................|SpaceVim-api-vim-buffer|
18. vim#command...............................|SpaceVim-api-vim-command|
19. vim#compatible.........................|SpaceVim-api-vim-compatible|
20. vim#message...............................|SpaceVim-api-vim-message|
21. vim#window.................................|SpaceVim-api-vim-window|
10. Development...............................................|SpaceVim-dev|
1. commit-style-guide..................|SpaceVim-dev-commit-style-guide|
11. FAQ.......................................................|SpaceVim-faq|
12. Changelog...........................................|SpaceVim-changelog|
==============================================================================
INTRODUCTION *SpaceVim-intro*
SpaceVim is a bundle of custom settings and plugins with a modular
configuration for Vim. It was inspired by Spacemacs.
==============================================================================
OPTIONS *SpaceVim-options*
SpaceVim uses `~/.SpaceVim.d/init.toml` as its default global config file. You
can set all the SpaceVim options and layers in it. `~/.SpaceVim.d/` will also
be added to runtimepath, so you can write your own scripts in it. SpaceVim
also supports local config for each project. Place local config settings in
`.SpaceVim.d/init.toml` in the root directory of your project. `.SpaceVim.d/`
will also be added to runtimepath.
here is an example setting SpaceVim options:
>
[options]
enable-guicolors = true
max-column = 120
<
==============================================================================
AUTOCOMPLETE_METHOD *SpaceVim-options-autocomplete_method*
Set the autocomplete engine of spacevim, the default logic is:
>
if has('python3')
let g:spacevim_autocomplete_method = 'deoplete'
elseif has('lua')
let g:spacevim_autocomplete_method = 'neocomplete'
elseif has('python')
let g:spacevim_autocomplete_method = 'completor'
elseif has('timers')
let g:spacevim_autocomplete_method = 'asyncomplete'
else
let g:spacevim_autocomplete_method = 'neocomplcache'
endif
<
and you can alse set this option to coc, then coc.nvim will be used. If you
are using neovim, you can also set this option to `nvim-cmp`, then nvim-cmp
will be used.
==============================================================================
AUTOCOMPLETE_PARENS *SpaceVim-options-autocomplete_parens*
Enable/Disable autocompletion of parentheses, default is true (enabled).
>
autocomplete_parens = false
<
==============================================================================
BOOTSTRAP_AFTER *SpaceVim-options-bootstrap_after*
set the bootstrap_after function, this function will be called on `VimEnter`
event.
>
[options]
bootstrap_after = 'myspacevim#after'
<
==============================================================================
BOOTSTRAP_BEFORE *SpaceVim-options-bootstrap_before*
set the bootstrap_before function, this function will be called when loading
custom configuration file. for example:
>
[options]
bootstrap_before = 'myspacevim#before'
<
==============================================================================
BOOTSTRAP_SCRIPT *SpaceVim-options-bootstrap_script*
set the bootstrap_script string, this string will be called via `nvim_exec`,
that means this option only can be used in neovim.
>
[options]
bootstrap_script = '''
let g:foo_test = 1
let g:zff_test = 1
'''
<
==============================================================================
BUFFER_INDEX_TYPE *SpaceVim-options-buffer_index_type*
Set SpaceVim buffer index type, default is 4.
>
# types:
# 0: 1 ➛ ➊
# 1: 1 ➛ ➀
# 2: 1 ➛ ⓵
# 3: 1 ➛ ¹
# 4: 1 ➛ 1
buffer_index_type = 1
<
==============================================================================
CHECKINSTALL *SpaceVim-options-checkinstall*
Enable/Disable checkinstall on SpaceVim startup. Default is true.
>
checkinstall = true
<
==============================================================================
CODE_RUNNER_FOCUS *SpaceVim-options-code_runner_focus*
enable/disable code runner window focus mode, by default this option is
`false`, to enable this mode, set this option to `true`.
>
code_runner_focus = true
<
==============================================================================
COLORSCHEME *SpaceVim-options-colorscheme*
The colorscheme of SpaceVim. Default is 'gruvbox'.
==============================================================================
COLORSCHEME_BG *SpaceVim-options-colorscheme_bg*
The background of colorscheme. Default is 'dark'.
==============================================================================
COMMANDLINE_PROMPT *SpaceVim-options-commandline_prompt*
Config the command line prompt for flygrep and denite etc. Default is `>`, for
example:
>
commandline_prompt = '➭'
<
==============================================================================
DATA_DIR *SpaceVim-options-data_dir*
Set the cache directory of SpaceVim. Default is `$XDG_CACHE_HOME` or if not
set `~/.cache¸.
>
data_dir = "~/.cache"
<
==============================================================================
DEFAULT_CUSTOM_LEADER *SpaceVim-options-default_custom_leader*
Change the default custom leader of SpaceVim. Default is <Space>.
>
default_custom_leader = "<Space>"
<
==============================================================================
DEFAULT_INDENT *SpaceVim-options-default_indent*
Change the default indentation of SpaceVim. Default is 2.
>
default_indent = 2
<
==============================================================================
ENABLE_BEPO_LAYOUT *SpaceVim-options-enable_bepo_layout*
Enable/Disable bepo layout, by default it is disabled.
>
enable_bepo_layout = true
<
==============================================================================
ENABLE_CURSORCOLUMN *SpaceVim-options-enable_cursorcolumn*
Enable/Disable cursorcolumn. Default is 0, cursorcolumn will be highlighted in
normal mode. To enable this feature:
>
enable_cursorcolumn = true
<
==============================================================================
ENABLE_CURSORLINE *SpaceVim-options-enable_cursorline*
Enable/Disable cursorline. Default is true, cursorline will be highlighted in
normal mode.To disable this feature:
>
enable_cursorline = false
<
==============================================================================
ENABLE_DEBUG *SpaceVim-options-enable_debug*
Enable/Disable debug mode for SpaceVim. Default is false.
>
enable_debug = true
<
==============================================================================
ENABLE_GOOGLESUGGEST *SpaceVim-options-enable_googlesuggest*
Enable/Disable Google suggestions for neocomplete. Default is false.
>
enable_googlesuggest = false
<
==============================================================================
ENABLE_GUICOLORS *SpaceVim-options-enable_guicolors*
Enable true color support in terminal. Default is false.
>
enable_guicolors = true
<
==============================================================================
ENABLE_KEY_FREQUENCY *SpaceVim-options-enable_key_frequency*
Enable/Disable key frequency catching of SpaceVim. default value is 0. to
enable it:
>
enable_key_frequency = true
<
==============================================================================
ENABLE_PROJECTS_CACHE *SpaceVim-options-enable_projects_cache*
Enable/Disable cross session projects cache. Enabled by default.
==============================================================================
ENABLE_STATUSLINE_BFPATH *SpaceVim-options-enable_statusline_bfpath*
Enable/Disable showing full path of current buffer on statusline, disabled by
default, to enable this feature:
>
enable_statusline_bfpath = true
<
==============================================================================
ENABLE_STATUSLINE_MODE *SpaceVim-options-enable_statusline_mode*
Enable/Disable display mode. Default is 0, mode will be displayed in
statusline. To enable this feature:
>
enable_statusline_mode = true
<
==============================================================================
ENABLE_STATUSLINE_TAG *SpaceVim-options-enable_statusline_tag*
Enable/Disable showing current tag on statusline
>
enable_statusline_tag = false
<
==============================================================================
ENABLE_TABLINE_FT_ICON *SpaceVim-options-enable_tabline_ft_icon*
Enable/Disable tabline filetype icon. default is false. To enable this
feature:
>
enable_tabline_ft_icon = true
<
==============================================================================
ENABLE_VIMFILER_WELCOME *SpaceVim-options-enable_vimfiler_welcome*
Enable/Disable vimfiler in the welcome windows. Default is true. This will
cause vim to start up slowly if there are too many files in the current
directory.
>
enable_vimfiler_welcome = false
<
==============================================================================
ENABLE_YCM *SpaceVim-options-enable_ycm*
Enable/Disable YouCompleteMe. Default is false.
>
enable_ycm = true
<
==============================================================================
ERROR_SYMBOL *SpaceVim-options-error_symbol*
Set the error symbol for SpaceVim's syntax maker. Default is '✖'.
>
error_symbol = "+"
<
==============================================================================
ESCAPE_KEY_BINDING *SpaceVim-options-escape_key_binding*
Set the key binding for switch to normal mode in insert mode. Default is `jk`,
to disable this key binding, set this option to empty string.
>
escape_key_binding = 'jk'
<
==============================================================================
EXPAND_TAB *SpaceVim-options-expand_tab*
In Insert mode: Use the appropriate number of spaces to insert a <Tab>
==============================================================================
FILE_SEARCHING_TOOLS *SpaceVim-options-file_searching_tools*
Set the default file searching tool used by `SPC f /`, by default it is `[]`.
The first item in this list is the name of the tool, the second one is the
default command. for example:
>
file_searching_tools = ['find', 'find -not -iwholename "*.git*" ']
<
==============================================================================
FILEMANAGER *SpaceVim-options-filemanager*
The default file manager of SpaceVim. Default is 'nerdtree'. you can also use
defx or vimfiler
==============================================================================
FILETREE_DIRECTION *SpaceVim-options-filetree_direction*
Config the direction of file tree. Default is 'right'. you can also set to
'left'.
NOTE: if it is 'left', the tagbar will be move to right.
==============================================================================
GUIFONT *SpaceVim-options-guifont*
Set the guifont of SpaceVim. Default is empty.
>
guifont = "SauceCodePro Nerd Font Mono:h11"
<
==============================================================================
HOME_FILES_NUMBER *SpaceVim-options-home_files_number*
Change the list number of files for SpaceVim home. Default is 6.
>
home_files_number = 6
<
==============================================================================
INFO_SYMBOL *SpaceVim-options-info_symbol*
Set the information symbol for SpaceVim's syntax maker. Default is '🛈'.
>
info_symbol = 'i'
<
==============================================================================
KEEP_SERVER_ALIVE *SpaceVim-options-keep_server_alive*
Option for keep the spacevim server ailive
==============================================================================
LANGUAGE *SpaceVim-options-language*
Set the message language of vim. Default is 'en_US.UTF-8'.
>
language = 'en_CA.utf8'
<
==============================================================================
LINT_ENGINE *SpaceVim-options-lint_engine*
Set the lint engine used in checkers layer, the default engine is neomake, if
you want to use ale, use:
>
lint_engine = 'ale'
<
NOTE: the `enable_neomake` and `enable_ale` option has been deprecated.
*spacevim-options-enable_naomake* *spacevim-options-enable_ale*
==============================================================================
LINT_ON_THE_FLY *SpaceVim-options-lint_on_the_fly*
Enable/Disable lint on the fly feature of SpaceVim's maker. Default is true.
>
lint_on_the_fly = false
<
==============================================================================
MAX_COLUMN *SpaceVim-options-max_column*
Change the max number of columns for SpaceVim. Default is 120.
>
max_column = 120
<
==============================================================================
PLUGIN_BUNDLE_DIR *SpaceVim-options-plugin_bundle_dir*
Set the cache directory of plugins. Default is `$data_dir/vimfiles`.
>
plugin_bundle_dir = "~/.cache/vimplugs"
<
==============================================================================
PLUGIN_MANAGER_PROCESSES *SpaceVim-options-plugin_manager_processes*
Set the max process of SpaceVim plugin manager
==============================================================================
PROJECT_AUTO_ROOT *SpaceVim-options-project_auto_root*
Enable/Disable project root detection. By default, SpaceVim will change the
directory to the project root directory based on `project_rooter_patterns`
option. To disable this feature:
>
[options]
project_auto_root = false
<
NOTE: *g:spacevim_project_rooter_automatically* and
*SpaceVim-options-project_rooter_automatically* are deprecated.
==============================================================================
PROJECT_NON_ROOT *SpaceVim-options-project_non_root*
This option set the default behavior for non-project files.
`current`: change to file's dir, like `autochdir`
`''`: do not change directory
`home`: change to home directory
==============================================================================
PROJECT_ROOTER_OUTERMOST *SpaceVim-options-project_rooter_outermost*
Enable/Disable finding outermost directory for project root detection. By
default SpaceVim will find the outermost directory based on
`project_rooter_patterns`. To find nearest directory, you need to disable this
option:
>
[options]
project_rooter_outermost = false
<
==============================================================================
PROJECT_ROOTER_PATTERNS *SpaceVim-options-project_rooter_patterns*
Set the project root patterns, SpaceVim determines the root directory of the
project based on this option. By default it is:
>
['.git/', '_darcs/', '.hg/', '.bzr/', '.svn/']
<
==============================================================================
PROJECTS_CACHE_NUM *SpaceVim-options-projects_cache_num*
Setting the numbers of cached projects, by default it is 20.
==============================================================================
REALTIME_LEADER_GUIDE *SpaceVim-options-realtime_leader_guide*
Enable/Disable realtime leader guide. Default is true. to disable it:
>
realtime_leader_guide = false
<
==============================================================================
RELATIVENUMBER *SpaceVim-options-relativenumber*
Enable/Disable relativenumber, by default it is enabled.
>
relativenumber = true
<
==============================================================================
RETRY_CNT *SpaceVim-options-retry_cnt*
Set the number of retries for SpaceVim Update when failed. Default is 3. Set
to 0 to disable this feature, or you can set to another number.
>
update_retry_cnt = 3
<
==============================================================================
SEARCH_TOOLS *SpaceVim-options-search_tools*
Default search tools supported by flygrep. The default order is ['rg', 'ag',
'pt', 'ack', 'grep', 'findstr', 'git'] The `git` command means using
`git-grep`. If you prefer to use `git-grep` by default. You can change this
option to:
>
[options]
search_tools = ['git', 'rg', 'ag']
<
==============================================================================
SIDEBAR_WIDTH *SpaceVim-options-sidebar_width*
Set the width of the SpaceVim sidebar. Default is 30. This value will be used
by tagbar and filetree.
==============================================================================
SNIPPET_ENGINE *SpaceVim-options-snippet_engine*
Set the snippet engine of SpaceVim, default is neosnippet. to enable
ultisnips:
>
snippet_engine = "ultisnips"
<
==============================================================================
STATUSLINE_ISEPARATOR *SpaceVim-options-statusline_iseparator*
Set the statusline separators of statusline in inactive windows, default is
'nil'
>
Separators options:
1. arrow
2. curve
3. slant
4. nil
5. fire
<
See more details in: http://spacevim.org/documentation/#statusline
==============================================================================
STATUSLINE_LEFT *SpaceVim-options-statusline_left*
Define the left section of statusline in active windows. By default:
>
statusline_left = [
'winnr',
'filename',
'major mode',
'minor mode lighters',
'version control info'
]
<
`statusline_left_sections` is deprecated, use `statusline_left` instead.
==============================================================================
STATUSLINE_RIGHT *SpaceVim-options-statusline_right*
Define the right section of statusline in active windows. By default:
>
statusline_right = [
'fileformat',
'cursorpos',
'percentage'
]
<
The following sections can be used in this option:
fileformat: the format of current file
cursorpos: the corsur position
percentage: the percent of current page
totallines: the total lines of current buffer
`statusline_right_sections` is deprecated, use `statusline_right` instead.
==============================================================================
STATUSLINE_SEPARATOR *SpaceVim-options-statusline_separator*
Set the statusline separators of statusline, default is 'nil'
>
Separators options:
1. arrow
2. curve
3. slant
4. nil
5. fire
<
See more details in: http://spacevim.org/documentation/#statusline
==============================================================================
STATUSLINE_UNICODE *SpaceVim-options-statusline_unicode*
Enable/Disable unicode symbols in statusline, includes the mode icons and
fileformat icons. This option is enabled by default, to disable it:
>
statusline_unicode = false
<
==============================================================================
TERMINAL_CURSOR_SHAPE *SpaceVim-options-terminal_cursor_shape*
Set the SpaceVim cursor shape in the terminal.
>
0 : to prevent Nvim from changing the cursor shape.
1 : to enable non-blinking mode-sensitive cursor.
2 : to enable blinking mode-sensitive cursor (default).
<
>
<
Host terminal must support the DECSCUSR CSI escape sequence. Depending on the
terminal emulator, using this option with nvim under tmux might require adding
the following to ~/.tmux.conf:
>
set -ga terminal-overrides ',*:Ss=\E[%p1%d q:Se=\E[2 q'
<
==============================================================================
TODO_LABELS *SpaceVim-options-todo_labels*
Option for setting todo labels in current project.
==============================================================================
TODO_PREFIX *SpaceVim-options-todo_prefix*
Option for setting todo prefix in current project. The default is `@`
==============================================================================
VIM_HELP_LANGUAGE *SpaceVim-options-vim_help_language*
Set the help language of vim. Default is 'en'. You can change it to Chinese.
>
vim_help_language = "cn"
<
==============================================================================
VIMCOMPATIBLE *SpaceVim-options-vimcompatible*
Enable/Disable vimcompatible mode, by default it is false. to enable
vimcompatible mode, just add:
>
vimcompatible = true
<
In vimcompatible mode all vim origin key bindings will not be changed.
Includes:
>
q smart quit windows
s windows key bindings leader
, language specific leader
<C-a> move cursor to beginning in command line mode
<C-b> move cursor to left in command line mode
<C-f> move cursor to right in command line mode
<C-x> switch buffer
<
==============================================================================
WARNING_SYMBOL *SpaceVim-options-warning_symbol*
Set the warning symbol for SpaceVim's syntax maker. Default is '⚠'.
>
warning_symbol = '!'
<
==============================================================================
WILDIGNORE *SpaceVim-options-wildignore*
A list of file patterns when file match it will be ignored.
>
wildignore = '*/tmp/*,*.so,*.swp,*.zip,*.class,tags,*.jpg,*.ttf,*.TTF,*.png
,*/target/*,.git,.svn,.hg,.DS_Store,*.svg'
<
==============================================================================
WINDISK_ENCODING *SpaceVim-options-windisk_encoding*
Setting the encoding of windisk info. by default it is `cp936`.
>
windisk_encoding = 'cp936'
<
==============================================================================
WINDOWS_INDEX_TYPE *SpaceVim-options-windows_index_type*
Set SpaceVim windows index type, default is 3.
>
# types:
# 0: 1 ➛ ➊
# 1: 1 ➛ ➀
# 2: 1 ➛ ⓵
# 3: 1 ➛ 1
windows_index_type = 1
<
==============================================================================
WINDOWS_LEADER *SpaceVim-options-windows_leader*
Window functions leader for SpaceVim. Default is `s`. Set to empty to disable
this feature, or you can set to another char.
>
windows_leader = ""
<
==============================================================================
WINDOWS_SMARTCLOSE *SpaceVim-options-windows_smartclose*
Set the default key for smart close windows, default is `q`. to disable this
feature, just set it to empty string:
>
windows_smartclose = ""
<
==============================================================================
CONFIGURATION *SpaceVim-config*
If you still want to use `~/.SpaceVim.d/init.vim` as configuration file,
please take a look at the following options add |SpaceVim-functions|
*g:spacevim_version*
Version of SpaceVim , this value can not be changed.
*g:spacevim_default_indent*
Change the default indentation of SpaceVim. Default is 2.
>
let g:spacevim_default_indent = 2
<
*g:spacevim_expand_tab*
In Insert mode: Use the appropriate number of spaces to insert a <Tab>
*g:spacevim_relativenumber*
Enable/Disable relativenumber in current windows, by default it is enabled.
*g:spacevim_wrap_line*
Enable/Disable line wrap of vim
*g:spacevim_enable_bepo_layout*
Enable/Disable bepo layout, by default it is disabled.
*g:spacevim_max_column*
Change the max number of columns for SpaceVim. Default is 120.
>
let g:spacevim_max_column = 120
<
*g:spacevim_default_custom_leader*
Change the default custom leader of SpaceVim. Default is <Space>.
>