-
-
Notifications
You must be signed in to change notification settings - Fork 199
/
dein.txt
2031 lines (1647 loc) · 68.1 KB
/
dein.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
*dein.txt* Dark powered Vim/Neovim plugin manager
Version: 3.1
Author: Shougo <Shougo.Matsu at gmail.com>
License: MIT license
==============================================================================
CONTENTS *dein-contents*
Introduction |dein-introduction|
Usage |dein-usage|
Install |dein-install|
Interface |dein-interface|
Functions |dein-functions|
Variables |dein-variables|
Options |dein-options|
Toml |dein-toml|
Lua Functions |dein-lua-functions|
Ddu Sources |dein-ddu-sources|
Denite Sources |dein-denite-sources|
Configuration Examples |dein-examples|
Plugins merged feature |dein-merge|
FAQ |dein-faq|
Compatibility |dein-compatibility|
==============================================================================
INTRODUCTION *dein-introduction*
*dein* is the dark powered Vim package manager. It is created from full
scratch.
Concepts are:
* Faster than NeoBundle
* Simple
* No commands, Functions only to simplify the implementation
* Easy to test and maintain
* No Vundle/NeoBundle compatibility
* neovim/Vim8 asynchronous API installation support
* Local plugin support
* Non github plugins support
* Go like clone directory name ex:"github.com/{user}/{repository}"
* Merge the plugins directories automatically to avoid long 'runtimepath'
==============================================================================
USAGE *dein-usage*
Refer to the example:
|dein-examples|
Run this command to update your plugins:
>
:call dein#update()
<
NOTE: The plugins are not updated automatically.
==============================================================================
INSTALL *dein-install*
Requirements:
* Vim 8.2+ or NeoVim 0.8+.
* "git" command in $PATH (if you want to install github or vim.org plugins)
First of all, git clone the repository.
NOTE: You must define the installation directory before to use dein. It
depends on your usage.
For example, "~/.vim/bundles" or "~/.cache/dein" or "~/.local/share/dein".
dein.vim does not define the default installation directory.
You must not set the installation directory under "~/.vim/plugin" or
"~/.config/nvim/plugin".
NOTE: You need to have git installed.
>
$ mkdir -p ~/.vim/bundle/repos/github.com/Shougo/dein.vim
$ git clone https://github.com/Shougo/dein.vim \
~/.vim/bundle/repos/github.com/Shougo/dein.vim
<
And set up a path to the repository directory.
>
set runtimepath+={path to dein directory}
<
Example:
>
set runtimepath+=~/.vim/bundle/repos/github.com/Shougo/dein.vim
<
Now configure your bundles. (Refer to |dein-examples|)
Call |dein#update()| function to install your plugins.
>
If you need vim-plug like install UI, you can use ddu-source-dein_update.
https://github.com/matsui54/ddu-source-dein_update
==============================================================================
INTERFACE *dein-interface*
------------------------------------------------------------------------------
FUNCTIONS *dein-functions*
*dein#add()*
dein#add({repo}[, {options}])
Initialize a plugin.
{repo} is the repository URI or local repository directory
path. If {repo} starts with github user name (ex:
"Shougo/dein.vim"), dein will install github plugins when
|dein#install()|.
See |dein-options| for what to set in {options}.
NOTE: If you install plugins, you need to call
|dein#install()| manually.
NOTE: If plugin is already defined, duplicated calls will be
ignored. If you want to overwrite plugin config, you need to
use |dein-options-overwrite| or |dein#config()| instead.
NOTE: You must call it in |dein#begin()| block.
*dein#begin()*
dein#begin({base-path}, [{vimrcs}])
Initialize dein.vim and start plugins configuration
block.
{base-path} is where your downloaded plugins will be placed.
For example, "Shougo/dein.vim" will be downloaded in
"{base-path}/repos/github.com/Shougo/dein.vim" directory.
{vimrcs} is a list of compared .vimrc and/or other
configuration(TOML) files. The default is |$MYVIMRC|.
The typical {base-path} is "~/.cache/dein" or
"~/.local/share/dein".
NOTE: You must not call the function inside a
"has('vim_starting')" block.
NOTE: It executes ":filetype off" automatically.
*dein#build()*
dein#build([{plugins}])
Build for {plugins}.
{plugins} is the plugins name list.
*dein#call_hook()*
dein#call_hook({hook-name})
Calls the hook {hook-name}.
NOTE: If {hook-name} is "source", dein will call "source"
hooks in sourced plugins.
*dein#check_install()*
dein#check_install({plugins})
Check {plugins} installation.
If {plugins} are not installed, it will return non-zero.
If {plugins} are invalid, it will return -1.
{plugins} are the plugins name list or the plugin name to
check.
If you omit it, dein will check all plugins installation.
NOTE: You can disable the message by |:silent|.
*dein#check_lazy_plugins()*
dein#check_lazy_plugins()
Check the no meaning lazy plugins. These plugins don't have
"plugin/" directory.
*dein#check_update()*
dein#check_update([{force}[, {plugins}]])
Check updated {plugins} by github GraphQL API.
https://docs.github.com/en/graphql
If {force} is |v:true|, it call |dein#update()| after updated
check.
{plugins} are the plugins name list or the plugin name to
check.
NOTE: You can use it for github plugins.
NOTE: It does not return value instead of
|dein#check_install()|.
NOTE: You need to set |g:dein#install_github_api_token| to use
the feature.
NOTE: The update check is quick but it is not perfect
solution. If "git" command change ".git" directory status(for
example: "git reset"), it cannot detect the update properly.
And github API cannot detect upstream changes immediately.
If you set |g:dein#install_check_remote_threshold|, the check
is more strict but slower.
*dein#check_clean()*
dein#check_clean()
Returns the non-used plugins directories. You can write the
wrap command to remove them.
*dein#clear_state()*
dein#clear_state()
Clear the state file manually.
*dein#config()*
dein#config({plugin-name}, {options})
dein#config({options})
Change plugin options for {plugin-name}.
It you omit {plugin-name}, it uses |g:dein#name| variable.
If {plugin-name} is list, you can change the options in the
multiple plugins.
If {plugin-name} is already loaded or invalid, it will be
ignored.
NOTE: You must call it within |dein#begin()| / |dein#end()|
block.
>
call dein#add('Shougo/deoplete.nvim')
call dein#config('deoplete.nvim', #{
\ lazy: 1,
\ on_event: 'InsertEnter',
\ })
<
*dein#deno_cache()*
dein#deno_cache({plugins})
Update {plugins} deno cache.
If you omit {plugins}, all plugins cache is updated.
It is executed automatically when plugins are updated.
NOTE: "deno" must be executable in your "$PATH".
*dein#direct_install()*
dein#direct_install({repo}[, {options}])
Direct install a plugin without editing the configuration.
The arguments are same with |dein#add()|.
It installs and sources the plugin.
NOTE: The direct installed plugins configuration is saved in
|dein#get_direct_plugins_path()|. You can load or edit it. >
" Try deoplete without the configuration.
call dein#direct_install('Shougo/deoplete.nvim')
<
*dein#disable()*
dein#disable({plugins})
Disables plugins specified by {plugins}.
{plugins} is the plugins name list.
NOTE: This command must be executed before dein loads
the plugins.
NOTE: The plugins must be disabled |dein-options-merged|.
Because merged plugins are moved to plugins directory and
loaded automatically.
NOTE: Disabled plugins are removed from dein's plugin list.
You cannot get disabled plugins from dein.
*dein#each()*
dein#each({command}[, {plugins}])
Execute {command} for {plugins}.
{plugins} is the plugins name list.
You can execute "git gc" command for the plugins.
*dein#end()*
dein#end()
End dein configuration block.
You must not use the plugins in |dein#begin()| block.
If you enable |g:dein#auto_recache|, it executes
|dein#recache_runtimepath()| automatically.
NOTE: 'runtimepath' is changed after |dein#end()|.
*dein#get()*
dein#get([{plugin-name}])
Get the plugin options dictionary for {plugin-name}.
If you omit {plugin-name}, dein will return the plugins
dictionary. The key is the plugin name. The value is the
plugin dictionary.
*dein#get_direct_plugins_path()*
dein#get_direct_plugins_path()
Get the direct installed plugins script path.
*dein#get_failed_plugins()*
dein#get_failed_plugins()
Get the previous installation failed plugins.
*dein#get_updated_plugins()*
dein#get_updated_plugins([, {plugins}])
Get updated {plugins} by github GraphQL API.
https://docs.github.com/en/graphql
{plugins} are the plugins name list or the plugin name to
check.
NOTE: You can use it for github plugins.
NOTE: You need to set |g:dein#install_github_api_token| to use
the feature.
*dein#get_log()*
dein#get_log()
Get all previous install logs.
*dein#get_progress()*
dein#get_progress()
Get current update progress message.
*dein#get_updates_log()*
dein#get_updates_log()
Print previous update logs.
*dein#install()*
dein#install([{plugins}])
Install the plugins asynchronously.
{plugins} is the plugins name list.
If you omit it, dein will install all plugins.
*dein#is_available()*
dein#is_available([{plugin-name}])
Return non-zero if {plugin-name} exists and is enabled.
*dein#is_sourced()*
dein#is_sourced({plugin-name})
Return non-zero if {plugin-name} exists and is sourced.
See |dein#source()| and |dein#tap()| as well.
*dein#load_dict()*
dein#load_dict({dict}, [{options}])
Load the plugin configuration from {dict}. {dict} is the
|Dictionary|. The key is the repository URI and the value is
the |dein-options| dictionary. See |dein-options| for keys to
set in {options}. >
call dein#load_dict({
\ 'Shougo/denite.nvim': {},
\ 'Shougo/deoplete.nvim': #{ name: 'deoplete' },
\ })
<
*dein#load_rollback()*
dein#load_rollback({rollbackfile}[, {plugins}])
Rollback {plugins} from {rollbackfile}.
NOTE: It is the dangerous command.
*dein#load_state()*
*dein#min#load_state()*
dein#load_state({base-path})
dein#min#load_state({base-path})
Load dein's state from the cache script, {base-path} is where
your downloaded plugins will be placed.
NOTE: You must call it before |dein#begin()|. It clears dein
all configuration.
NOTE: It overwrites your 'runtimepath' completely, you must
not call it after change 'runtimepath' dynamically.
NOTE: The block is skipped if dein's state is loaded.
NOTE: |dein#min#load_state()| is faster a bit.
It returns 1, if the cache script is old or invalid or not
found.
>
if dein#min#load_state(path)
call dein#begin(path)
" My plugins here:
" ...
call dein#end()
call dein#save_state()
endif
<
*dein#load_toml()*
dein#load_toml({filename}, [{options}])
Load TOML plugin configuration from {filename}. See
|dein-options| for keys to set in {options}.
NOTE: TOML parser is slow. You should use it with
|dein#load_state()| and |dein#save_state()|.
NOTE: You need to specify toml files in |dein#begin()|
argument.
For toml file formats: |dein-toml|
>
let s:toml = '~/test_vim/lazy.toml'
if dein#load_state('~/test_vim/.cache/dein')
call dein#begin('~/test_vim/.cache/dein')
call dein#load_toml(s:toml, #{ lazy: 1 })
call dein#end()
call dein#save_state()
endif
<
*dein#local()*
dein#local({directory}, [{options}, [{names}]])
Add the subdirectories in {directory} to 'runtimepath', like
"pathogen" does. See |dein-options| for keys to set in
{options}.
If {names} is given, {names} directories are only loaded.
{names} is |wildcards| list.
>
" Load plugin from "~/.vim/bundle".
call dein#local("~/.vim/bundle")
" Load plugin1 and plugin2 from "~/.vim/bundle".
call dein#local("~/.vim/bundle", {},
\ ['plugin1', 'plugin2', 'vim-*', '*.vim'])
<
*dein#options()*
dein#options({options})
Set |dein-variables| by {options} dictionary.
NOTE: It is just syntax sugar.
>
call dein#options(#{
\ lazy_plugins: v:true,
\ install_progress_type: 'floating',
\ })
*dein#toml#syntax()*
dein#toml#syntax()
Enable dein specific toml syntax.
It highlights multiline string as "vim" or "lua" syntax.
If you use neovim, you should use treesitter highlight
instead.
*dein#update()*
dein#update([{plugins}])
Install/Update the plugins.
{plugins} is the plugins name list.
If you omit it, dein will update all plugins.
NOTE: If you are using neovim or Vim 8.0+, it runs
asynchronously.
*dein#plugins2toml()*
dein#plugins2toml({plugins})
Returns the toml configurations for {plugins}
{plugins} is the plugins dictionary from |dein#get()|.
*dein#post_sync()*
dein#post_sync({plugins})
Execute an process needed after the plugins are updated.
It can be used to create third-party dein upgrader.
{plugins} is the plugins name list that was updated.
*dein#reinstall()*
dein#reinstall({plugins})
Reinstall the plugins.
{plugins} is the plugins name list.
*dein#remote_plugins()*
dein#remote_plugins()
Load not loaded neovim |remote-plugin| and execute
":UpdateRemotePlugins" command.
It is better than ":UpdateRemotePlugins" for dein.
NOTE: It is valid only in neovim.
*dein#rollback()*
dein#rollback({date}[, {plugins}])
Rollback to the latest matched {date} revisions for {plugins}.
If {date} is "", it rollbacks to the latest revisions.
{plugins} is the plugins name list.
NOTE: It is the dangerous command.
*dein#recache_runtimepath()*
dein#recache_runtimepath()
Re-make the dein runtimepath cache and execute |:helptags|.
It is called automatically after the installation.
*dein#save_rollback()*
dein#save_rollback({rollbackfile}[, {plugins}])
Save {plugins} rollback information to {rollbackfile}.
*dein#save_state()*
dein#save_state()
Save dein's state in the cache script.
It must be after |dein#end()|.
NOTE: It is available when loading .vimrc.
NOTE: It saves your 'runtimepath' completely, you must not
call it after change 'runtimepath' dynamically.
*dein#set_hook()*
dein#set_hook({plugins}, {hook-name}, {hook})
{plugins} is the plugins name list.
If it is empty list, it means all plugins.
Set hook {hook} as {hook-name} in {plugins}.
It can be called after |dein#begin()| / |dein#end()| block.
NOTE: If it is |Funcref|, it does not work in
|dein#load_state()| / |dein#save_state()| block.
>
call dein#add('Shougo/neosnippet.vim', #{ lazy: 1 })
function! Foo() abort
endfunction
" Does not work for dein#load_state()/dein#save_state() block
call dein#set_hook('neosnippet.vim',
\ 'hook_source', function('Foo'))
" Does work for dein#load_state()/dein#save_state() block
call dein#set_hook('neosnippet.vim',
\ 'hook_source', 'echomsg "foo"')
<
*dein#source()*
dein#source([{plugins}])
|:source| the plugins specified by {plugins}.
{plugins} is the plugins name list.
If you omit it, dein will source all plugins.
It returns sourced plugins list.
*dein#tap()*
dein#tap({plugin-name})
Return non-zero if {plugin-name} exists and isn't
disabled.
It initializes |g:dein#name| and |g:dein#plugin| variables.
------------------------------------------------------------------------------
VARIABLES *dein-variables*
*g:dein#auto_recache*
g:dein#auto_recache
If you set it to |v:true|, call |dein#recache_runtimepath()|
automatically in |dein#save_state()|.
NOTE: It is slow especially Windows.
Default: v:false
*g:dein#auto_remote_plugins*
g:dein#auto_remote_plugins
If you set it to |v:true|, call |dein#remote_plugins()|
automatically in |dein#recache_runtimepath()|.
Default: v:true
*g:dein#cache_directory*
g:dein#cache_directory
The cache directory to use.
Default: Under the base directory you have already specified
by |dein#begin()|.
*g:dein#default_options*
g:dein#default_options
The default options for plugins.
Default: {}
*g:dein#download_command*
g:dein#download_command
The default download command.
Default: "curl --silent --location --output" or "wget -q -O"
or use PowerShell.
*g:dein#enable_hook_function_cache*
g:dein#enable_hook_function_cache
If you set it to 1, function hooks will be saved in
|dein#save_state()|.
See |dein-hooks| notes.
NOTE: |lambda| function is not supported.
Defaults: v:false
*g:dein#enable_name_conversion*
g:dein#enable_name_conversion
If you set it to 1 and omit plugin name,
|dein-options-normalized_name| is used as plugin name.
It is useful for absorbing difference of repository name.
Defaults: v:false
*g:dein#enable_notification*
g:dein#enable_notification
If you set it to 1, dein uses the notification feature.
In neovim: Use "nvim-notify" or |nvim_notify()| API
https://github.com/rcarriga/nvim-notify
In Vim: Use "vim-notification" or |popup_notification()| API
https://github.com/mattn/vim-notification
Defaults: v:false
*g:dein#ftplugin*
g:dein#ftplugin
"_" key is executed after all ftplugin.
"{filetype}" key is executed {filetype} ftplugin.
"lua_{filetype}" key is executed {filetype} ftplugin as
|:lua|.
You can define multiple filetypes by "{filetype1}_{filetype2}"
key. "b:undo_ftplugin" is defined automatically.
NOTE: You need to call |dein#recache_runtimepath()| or enable
|g:dein#auto_recache| after vimrc is changed.
>
let g:dein#ftplugin = #{
\ _: 'echo 5555',
\ python: 'setlocal foldmethod=indent',
\ }
<
Default: {}
*g:dein#hooks_file_marker*
g:dein#hooks_file_marker
The marker is used in |dein-options-hooks_file|.
Defaults: 'foldmarker'
*g:dein#inline_vimrcs*
g:dein#inline_vimrcs
The vimrcs are sourced in |dein#begin()| or
|dein#load_state()| before hooks.
NOTE: It must be set before |dein#begin()|.
NOTE: The files must not be included "<<" pattern(here
document). It breaks the parser.
NOTE: It also supports ".lua" file for neovim.
Defaults: []
*g:dein#install_check_diff*
g:dein#install_check_diff
It checks plugins documentation diff when updated plugins.
NOTE: Dein outputs the diff to new buffer in the background.
Defaults: v:false
*g:dein#install_check_remote_threshold*
g:dein#install_check_remote_threshold
If the repository is updated newer than the threshold, use
strict "git ls-remote" check when |dein#check_update()|.
The unit is second.
Defaults: 0
>
" Strict check updated plugins yesterday
let g:dein#install_check_remote_threshold = 24 * 60 * 60
<
*g:dein#install_copy_vim*
g:dein#install_copy_vim
It use Vim script copy routine when
|dein#recache_runtimepath()|.
Defaults: v:true
*g:dein#install_github_api_token*
g:dein#install_github_api_token
github API key to use |dein#check_update()|.
https://github.com/settings/tokens
Defaults: ""
*g:dein#install_max_processes*
g:dein#install_max_processes
The max number of processes used for dein/install source
asynchronous update.
If it is less than equal 1, this feature is disabled.
Defaults: "16"(Windows) or "8"(Others)
*g:dein#install_process_timeout*
g:dein#install_process_timeout
The time of timeout seconds when updating/installing plugins.
Defaults: "120"
*g:dein#install_progress_type*
g:dein#install_progress_type
The output type of the progress bar in the installer.
NOTE: If you want to display the progress in the 'statusline',
you should use |dein#get_progress()|.
"none":
Disabled.
"echo":
Displayed in the echo area.
"tabline":
Displayed in the 'tabline'.
"title":
Displayed in the 'titlestring'.
NOTE: It is neovim only support
"floating":
Displayed in the floating/popup window.
Defaults: "echo"
*g:dein#install_message_type*
g:dein#install_message_type
The output type of the messages in the installer.
"none":
Disabled.
"echo":
Displayed in the echo area.
*g:dein#install_log_filename*
g:dein#install_log_filename
The log filename. Set it to "" to disable logging.
NOTE: This option slows your installation process.
Default: ""
*g:dein#lazy_rplugins*
g:dein#lazy_rplugins
If you set it to 1, neovim remote plugins are lazy loaded.
It is useful to save startup time.
NOTE: It disables all remote plugins at startup. You must
define all remote plugins as lazy loaded if it is enabled.
Defaults: v:false
*g:dein#name*
g:dein#name
Current plugin name.
You can only use it in |dein#tap()| block.
NOTE: The variable is deprecated.
*g:dein#notification_icon*
g:dein#notification_icon
The notification icon path or stocked icon to display.
Default: ""
*g:dein#notification_time*
g:dein#notification_time
This is the time the notification should be displayed in
milli seconds.
Default: 2000
*g:dein#plugin*
g:dein#plugin
Current plugin.
You can use it in |dein#tap()| block or |dein-hooks|.
*g:dein#types#git#clone_depth*
g:dein#types#git#clone_depth
The default history depth for "git clone".
If it is 1, dein will use shallow clone feature.
See |dein-options-type__depth|.
NOTE: If it is set, |dein-options-rev| does not work. Because
the history is not downloaded.
Default: 0
*g:dein#types#git#command_path*
g:dein#types#git#command_path
The "git" command path used for git type.
Default: "git"
*g:dein#types#git#default_hub_site*
g:dein#types#git#default_hub_site
The default hub site used for git type.
Default: "github.com"
*g:dein#types#git#default_protocol*
g:dein#types#git#default_protocol
The default protocol used for git (github).
NOTE: It only accepts "https" or "ssh".
Default: "https"
*g:dein#types#git#enable_partial_clone*
g:dein#types#git#enable_partial_clone
Enable partial clone when plugin install. It is faster.
NOTE: git 2.19+ is required.
Default: v:false
*g:dein#types#git#pull_command*
g:dein#types#git#pull_command
The git command used to pull updates.
Default: "pull --ff --ff-only"
------------------------------------------------------------------------------
OPTIONS *dein-options*
The {options} accepts the following keys:
*dein-options-augroup*
augroup (String)
An augroup name that the plugin uses for |VimEnter| or
|GUIEnter| autocmd events.
*dein-options-build*
build (String)
Specify the build script.
This command is executed by |system()| in the plugin
runtimepath.
NOTE: In previous versions of dein, build could also be of
type dictionary, but that is now deprecated.
Please use |dein-options-hook_post_update| instead.
Example:
>
call dein#add('Shougo/vimproc.vim', #{ build: 'make' })
<
NOTE: The command is executed in plugin top directory.
If you need cd command, you must use "sh -c". >
call dein#add('wincent/command-t', #{
\ build:
\ 'sh -c "cd ruby/command-t && ruby extconf.rb && make"'
\ })
<
*dein-options-denops_wait*
denops_wait (Bool)
If set to v:false, dein doesn't wait until the denops plugin
is loaded.
NOTE: It is danger option. The plugin does not work well.
*dein-options-depends*
depends (List or String)
Specify a list of plugins a plugin depends on.
List items are '{plugin-name}'.
Those specified in the list are NOT installed automatically.
NOTE: The loading order is not guaranteed in non lazy plugins.
*dein-options-frozen*
frozen (Bool)
If set to v:true, dein doesn't update it automatically. It is
useful for outdated plugins that can no longer be updated.
*dein-options-ftplugin*
ftplugin (Dictionary)
"_" key is executed after all ftplugin.
"{filetype}" key is executed {filetype} ftplugin.
"lua_{filetype}" key is executed {filetype} ftplugin as
|:lua|.
NOTE: You need to call |dein#recache_runtimepath()| or enable
|g:dein#auto_recache| after vimrc is changed.
*dein-options-if*
if (Bool) or (String)
If set to |v:false|, dein doesn't load the plugin.
If it is |String|, dein will eval it.
If you don't set it, dein will register (enable) the plugin.
NOTE: You cannot disable plugins register in dein if you use
the option.
*dein-options-lazy*
lazy (Bool)
If set to v:true, dein doesn't add the path to 'runtimepath'
automatically.
If you don't set it, dein will set it automatically when the
conditions are met.
NOTE: You should not specify the plugins which have no
"plugin/" directory as lazy load plugins. It is meaningless
and just increases the overhead. You can get the no meaning
lazy plugins by |dein#check_lazy_plugins()|.
*dein-options-merged*
merged (Bool)
If set to v:false, dein doesn't merge the plugin directory.
It is useful for the plugin files conflicts.
Default: See |dein-merge|.
*dein-options-merge_ftdetect*
merge_ftdetect (Bool)
If set to v:true, dein merge the plugin "ftdetect" directory.
It is useful to enable file detection when lazy loaded plugin.
NOTE: It does not work if ftdetect script depends on lazy
plugin functions.
*dein-options-name*
name (String)
Specify the name of the plugin. This is used for dein
management and other functions. If it is omitted, the tail of
the repository name will be used.
NOTE: Must be unique across the all plugin. If the plugin
name conflicts with another plugin, dein will overwrite the
previous settings with the new one. If the repo tail is bound
to conflict, you can set the "name" option manually to prevent
overwriting an existing plugin setting.
*dein-options-normalized_name*
normalized_name (String)
Specify the normalized name of the plugin. If omitted, dein
will normalize the tail of the repository name.
NOTE: Must be unique across all plugins.
Normalized name example:
name : normalized name
>
denite.nvim denite
dein.vim dein
vim-quickrun quickrun
dps-dial dial
denops-foo foo
<
*dein-options-on_cmd*
on_cmd (List) or (String)
If it is matched to the executed command, dein will call
|dein#source()|.
*dein-options-on_event*
on_event (String) or (List)
dein will call |dein#source()| on the events.
*dein-options-on_func*
on_func (List) or (String)
If it is matched to the called function, dein will call
|dein#source()|.
NOTE: It does not work when Vim initialized.
NOTE: It does not work for Vim9 script. It is |FuncUndefined|
limitation.
NOTE: It does not work for |autoload-functions|.
*dein-options-on_ft*
on_ft (List) or (String)
If it is matched to 'filetype', dein will call
|dein#source()|.
*dein-options-on_if*
on_if (String)
If it is evaluated and it is non-zero, dein will call
|dein#source()|.
The default evaluate timings are "BufRead", "BufNewFile",
"VimEnter" and "FileType".
If |dein-options-on_event| exists, it is evaluated when
|dein-options-on_event|.
For example: >
call dein#add('blueyed/vim-diminactive',
\ #{ on_event: 'WinEnter', on_if: 'winnr("$") > 1' })
<
*dein-options-on_lua*
on_lua (List) or (String)
If it is matched to the required lua module root, dein will
call |dein#source()|.
NOTE: It is for neovim only.
NOTE: It does not work for neovim standard modules and require
in |vim.loop| modules.
NOTE: You cannot require on_lua plugins in
|dein-options-hook_add|. Because the plugins are not
initialized.
*dein-options-on_map*
on_map (Dictionary) or (List) or (String)
If it is the Dictionary, the key is {mode} and the items are
{mapping} or [{mapping1}, {mapping2}, ...].
If it is the List, the items are {mapping} or [{mode},
{mapping1}, [{mapping2}, ...]].
If {mode} is omitted, "nxo" is used.
NOTE: You can use plugin prefix mappings.
For example, you can use "<Plug>(ref-" instead of
"<Plug>(ref-back)" and so on.
For example: >
call dein#add('Shougo/deol.nvim',
\ #{ on_map: #{ n: '<Plug>' } })
<
NOTE: You can use "<Plug>" keyword as {mapping}. If
{mapping} is "<Plug>", "<Plug>({normalized_name}" is
used.
For example: >
" It is same as "'on_map': '<Plug>(anzu'"
call dein#add('osyo-manga/vim-anzu', #{ on_map: '<Plug>' })
" It is same as "'on_map': '<Plug>(easy-align'"
" But it does not work as expected. Because the plugin
" defines '<Plug>(EasyAlign)' mapping instead.
call dein#add('junegunn/vim-easy-align',
\ #{ on_map: '<Plug>' })
" This works as expected
call dein#add('junegunn/vim-easy-align',
\ #{ on_map: '<Plug>(EasyAlign)' })
<
NOTE: You cannot use lazy <Plug> mappings twice.
For example: >
call dein#add('osyo-manga/vim-anzu',
\ #{ on_map: '<Plug>(anzu-' }
" Not working!!
nnoremap n
\ <Plug>(anzu-jump-n)<Plug>(anzu-echo-search-status)zv
nnoremap N
\ <Plug>(anzu-jump-N)<Plug>(anzu-echo-search-status)zv
<
*dein-options-on_path*
on_path (List) or (String)
If set to ".*", dein will call |dein#source()| on editing all
files. Otherwise, dein will call |dein#source()| if the
buffer name is matched to the string pattern.
NOTE: It is useful for explorer behavior plugins.
*dein-options-on_source*
on_source (List) or (String)
Load the plugin before the listed plugins are loaded.
NOTE: The plugins must be lazy loaded plugins.
*dein-options-overwrite*
overwrite (Bool)
If set to v:true, dein overwrite existing plugin config when
|dein#add()|.
*dein-options-path*
path (String)
Specify the plugin downloaded path.
*dein-options-rev*
rev (String)
Specify a revision number or branch/tag name.
If it is "*" in "git" type, dein will use latest released tag.
You can specify the wildcards like "0.*".
NOTE: If the type is "raw", rev must be hash number.
Example:
>
call dein#add('Shougo/deol.nvim', #{ rev: 'a1b5108fd5' })
<
*dein-options-rtp*
rtp (String)
Specify the runtime path.
You can use it when the repository has the Vim plugin in a
subdirectory.
For example: https://github.com/rstacruz/sparkup